vexura/keyhelp-api

A full-featured implementation of the KeyHelp API

v1.0.0 2022-10-22 13:59 UTC

Requires

• php: >=7.2
• ext-json: *
• guzzlehttp/guzzle: ^7.5

Requires (Dev)

• phpunit/phpunit: ^9.5.0

GPL-3.0-or-later

• Julien Michell Herwig

README

This PHP 7.2+ library allows you to communicate with the KeyHelp-API.

You can find the full API documentation here!

Getting Started

Recommended installation is using Composer!

In the root of your project execute the following:

$ composer require vexura/keyhelp-api

Or add this to your composer.json file:

{
    "require": {
        "vexura/keyhelp-api": "^1.0"
    }
}

Then perform the installation:

$ composer install --no-dev

Examples

Creating the KeyHelpAPI main object:

<?php
// Require the autoloader
require_once 'vendor/autoload.php';
// Use the library namespace
use KeyHelpAPI\KeyHelpAPI;
// Then simply pass your API-Token when creating the API client object.
$client = new KeyHelpAPI('API-Token');
// Then you are able to perform a request
var_dump($client->server()->getPing());
?>