hitslab/leads-su-sdk

SDK Leads.su

v0.1.2 2019-06-22 20:20 UTC

Requires

• php: ^7.1.3
• doctrine/annotations: ^1.0
• phpdocumentor/reflection-docblock: ^4.0
• symfony/property-access: ^4.0
• symfony/property-info: ^4.0
• symfony/serializer: ^4.0

MIT

• Ладыгин Александр

• sdk
• leads.su

README

С помощью API внешние приложения могут формировать отчеты, получать сведения о конверсиях, офферах и прочих объектах системы. Доступ к API имеют только пользователи с правами "Доступ к API". Получить API токен можно в разделе Информация об аккаунте.

Документация по API

Примеры использования

Инициализация API клиента

use Hitslab\LeadsSuSDK\ApiClient;

// Инициализируем API клиент, передаем токен доступа
$apiClient = new ApiClient("CTfX6npQragyZeXN4Xc6p7dyi89vZGPN");

Запрос списка присоединенных офферов

use Hitslab\LeadsSuSDK\Entity\Offer;
use Hitslab\LeadsSuSDK\Exception\ApiErrorException;
use Hitslab\LeadsSuSDK\Exception\BadResponseException;
use Hitslab\LeadsSuSDK\Exception\SdkException;
use Hitslab\LeadsSuSDK\Request\ConnectedOffersRequest;
use Hitslab\LeadsSuSDK\Response\OffersResponse;

try {
    /** @var OffersResponse $connectedOffers */
    $connectedOffers = (new ConnectedOffersRequest($apiClient))
        ->request();

    foreach ($connectedOffers->data as $connectedOffer) {
        /** @var Offer $connectedOffer */
        echo $connectedOffer->name . "\n";
    }
} catch (ApiErrorException $e) {
    // Ответ от API с ошибкой
} catch (BadResponseException $e) {
    // Неправильный ответ от сервера
} catch (SdkException $e) {
    // Ошибка в работе SDK, например ошибка десереализации ответа
}

Запрос списка присоединенных офферов с возвратом итератора

use Hitslab\LeadsSuSDK\Entity\Offer;
use Hitslab\LeadsSuSDK\Exception\ApiErrorException;
use Hitslab\LeadsSuSDK\Exception\BadResponseException;
use Hitslab\LeadsSuSDK\Exception\SdkException;
use Hitslab\LeadsSuSDK\Request\ConnectedOffersRequest;
use Hitslab\LeadsSuSDK\Response\IterableResponse;

try {
    /** @var IterableResponse $connectedOffers */
    $connectedOffers = (new ConnectedOffersRequest($apiClient))
        ->iterable()
        ->limit(20)
        ->request();

    foreach ($connectedOffers as $connectedOffer) {
        /** @var Offer $connectedOffer */
        echo $connectedOffer->name . "\n";
    }
} catch (ApiErrorException $e) {
    // Ответ от API с ошибкой
} catch (BadResponseException $e) {
    // Неправильный ответ от сервера
} catch (SdkException $e) {
    // Ошибка в работе SDK, например ошибка десереализации ответа
}