silinternational/apiaxle-sdk-php

PHP client for ApiAxle APIs

2.0.2 2024-10-30 15:33 UTC

Requires

• php: >=5.4
• forevermatt/calc-api-sig: ^0.1.1
• guzzlehttp/guzzle: ^7.4.5
• guzzlehttp/guzzle-services: ^0.6 || ^1.0
• roave/security-advisories: dev-master

Requires (Dev)

• phpunit/phpunit: ^9.0
• satooshi/php-coveralls: ^1.0.1
• silinternational/php-env: ^0.2.0

Suggests

• roave/security-advisories: Make sure you don't install dependencies with known issues. Install dev-master version.

MIT

• SIL GTIS

README

This library provides coverage for the ApiAxle API. It was built using Guzzle and Guzzle Services for simplicity of development and maintenance.

Installation

Install using composer:

composer require silinternational/apiaxle-sdk-php:^1.0.0

Usage

Each resource has its own class:

• Api: Apiaxle\Api
• Key: Apiaxle\Key
• Keyring: Apiaxle\Keyring

For each resource you instantiate the object by passing in a configuration array with at least the following parameters:

• endpoint: The Endpoint URL for your ApiAxle installation
• key: The API Key required for authenticating with the ApiAxle API
• secret: The Shared Secret required for calculating an API signature

Example:

use Apiaxle\Api;

$client = new Api([
    'endpoint' => 'https://apiaxle.api.mydomain.com',
    'key' => 'abc123',
    'secret' => 'abcdefghijklmnopqrstuvwxyz1234567890',
]);

Creating an API:

use Apiaxle\Api;

$client = new Api([
    'endpoint' => 'https://apiaxle.api.mydomain.com',
    'key' => 'abc123',
    'secret' => 'abcdefghijklmnopqrstuvwxyz1234567890',
]);

$api = $client->create([
    'id' => 'myapi',
    'endpoint' => 'myapiendpoint.com',
    'protocol' => 'https',
    'strictSSL' => true,
    'defaultPath' => '/api',
]);

print_r($api);

Output:

Array
(
    [statusCode] => 200
    [meta] => Array
        (
            [version] => 1
            [status_code] => 200
        )

    [results] => Array
        (
            [protocol] => https
            [apiFormat] => json
            [endPointTimeout] => 2
            [disabled] => false
            [strictSSL] => true
            [sendThroughApiKey] => false
            [sendThroughApiSig] => false
            [endPoint] => myapiendpoint.com
            [createdAt] => 1389915291013
            [tokenSkewProtectionCount] => 3
            [hasCapturePaths] => false
            [allowKeylessUse] => false
            [keylessQps] => 2
            [keylessQpd] => 172800
            [updatedAt] => 1427892638934
        )

)

License

MIT License

Copyright (c) 2016 SIL International

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.