README

Requirements

The only lib required is Guzzle, PHP HTTP client.

Installation

composer require ems-shield/ems-shield-php-client

OpenAPI specification file

This PHP client lib was generated using the openapi.json file located in the root directory. Copy this file content in editor.swagger.io to see all the possibilities.

Use

Initialize the client

ems-shied api uses OAuth2 access authentication.

The first parameter must be a valid access token. The second parameter is the API entry point url. The third one is optional and is an array of headers that will be apply to every requests of the internal Guzzle client, allowing to specify the accepted language for errors eg.

/** @var \EmsShield\Api\ApiClient $apiClient */
$apiClient = new \EmsShield\Api\ApiClient(
    $token,
    'https://ems-shield-api-entry-point.tld',
    ['Accept-Language' => 'en']
);

Request resources with managers

Handle resources requesting with the main API client object like this :

/** @var \EmsShield\Api\Resources\UserResponse $userResponse */
$userResponse = $apiClient->MeManager()->getUser();

/** @var \EmsShield\Api\Resources\User $me */
$me = $userResponse->data;

TODO

More documentation to come with the first release...

Features to come :

Link to the main documentation
Generated unit test

ems-shield / ems-shield-php-client

Maintainers

Details