oktey/api-php-v1

Api PHP client for Oktey services - version 1

1.0.5 2017-03-22 10:26 UTC

Requires

• php: >=5.6.0
• guzzlehttp/guzzle: 6.2.*

Requires (Dev)

• cakephp/cakephp-codesniffer: dev-master
• jakub-onderka/php-parallel-lint: ^0.9.2
• phpro/grumphp: ^0.11.3
• phpunit/phpunit: 5.*

MIT

• Stéphane Manhes
• Erwane Breton

• api
• oktey
• altospam
• mailout

README

Api PHP : Version 1

Installation

Vu les dépendances utilisées, il est impératif d'utiliser composer

# Si composer n'est pas encore installé
curl -sS https://getcomposer.org/installer | php
mv composer.phar composer

php composer require oktey/api-php-v1

Fonctionnalités

Voici les fonctionnalités de l'API ainsi que leurs liens de documentation

en lecture

• recherche d'un client
• liste des clients
• détail d'un client

en écriture

• création d'un client
• création d'une commande de test
• création d'un domaine

Usage

<?php
namespace App;

// Utiliser l'autoloader composer
require __DIR__ . '/vendor/autoload.php';

use Oktey\Api\Client;
use Exception;

// Afficher les erreurs en mode développement
ini_set('display_errors', 1); ini_set('html_errors', 1);

// Création de l'objet API
$Api = new Client('apiId', 'apiSecret');

try {
    // Requête sur l'api
    $response = $Api->get('/customers/lite');

    if ($response->success()) {
        // Récupération des données
        $customers = $response->getData();

        // affichage ;)
        var_dump($customers);
    } else {
        trigger_error(sprintf('Error %d : %s', $response->getStatus(), $response->getMessageError()), E_USER_WARNING);
    }
} catch(Exception $e) {
    // Oops !!!
    trigger_error(sprintf('Api Exception %d : %s', $e->getCode(), $e->getMessage()), E_USER_WARNING);
}