helpim/api-client-php

Helpim API. PHP client

1.0 2017-09-28 13:10 UTC

Requires

• php: >=5.5
• ext-curl: *

MIT

• Helpim

• api
• helpim

README

Требования

• PHP версии 5.5+
• PHP-расширение cURL

Установка через composer

1. Установить composer в проект:

curl -sS https://getcomposer.org/installer | php

1. Добавить в зависимости пакет:

php composer.phar require helpim/api-client-php

1. Подключить автозагрузку файлов классов:

require 'vendor/autoload.php';

Использование

Каждый запрос должен содержать идентификатор сервиса (customerServiceId), авторизационный токен (token) и набор данных, представляющий собой массив элементов.

Допустимые наборы данных

• customers - наполнение справочника клиентов;
• nomenclature - наполнение справочника номенклатуры;
• orders - передача заказов в обработку;
• statuses - наполнение справочника статусов.

Пример

function sendOrder()
{
    $defaultFields = [
        'customerServiceId' => 123,
        'token' => 'myLongSecureToken'
    ];
    
    $api = new \Helpim\Api\Client\HttpClient($defaultFields);
    
    $newOrder = [
        
        'external' => [
          'id' => 12345,
          'number' => 'ABC12345'
        ],
        'customer' => [
          'fullName' => 'Иванов Иван',
          'phoneNumber1' => '[phone]'
        ]
    ];
    
    try {
        $response = $api->request([
            'orders' => [
                $newOrder
            ]
        ]);
    } catch (\Helpim\Api\Exception\CurlException $e) {
        printf('Error %d: %s', $e->getCode(), $e->getMessage());
        return false;
    }
    
    if (!$response->isSuccessful()) {
        printf('Error %d: %s: %s', $response->getStatusCode(), $response->getError(), $response->getMessage());
        return false;
    }

    return true;
}