Что такое API документация?

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

Документация по работе с API доступна в разделе API документация как у администратора, так и у партнера. В ней представлен список методов с подробным описанием и примерами.

Назначение API:

Внешнее API необходимо партнерам и клиентам для программного доступа к информации партнерской сети. С его помощью они могут:

Разрабатывать программные продукты для привлечения и анализа трафика.
Следить за конверсиями и выплатами.

Авторизация в API

Способ авторизации:

Авторизация осуществляется через API-ключ, который передается в заголовках каждого запроса.

Формирование API-ключа:

Генерируется администратором или партнером в своем профиле.
Представляет собой хэш длиной 64 символа.
Передается в заголовке API-KEY.

Пример передачи API-ключа:

API-KEY: d83774cba062c755fc44749b949c17a5

Смена API-ключа:

Пользователь может сгенерировать новый API-ключ.
Запросы со старым ключом получат 403 Forbidden (ошибка доступа).

Доступ к API:

Даже если администратор или партнер имеет статус Неактивен, API остается доступным.

API URL

Структура URL для запросов:

По умолчанию:

{client-name}.api.alanbase.com

При наличии основного домена у

api.{client-domain} (например, https://api.mysite.com)

Оба варианта URL остаются рабочими.