Авторизация

Примечание

Если у логина уже существует действующий токен API Adfox, используемый для управления объектами, получать дополнительный токен для доступа к статистике не нужно. Для всех разделов API используется единый токен авторизации.

Получение токена

Чтобы получить токен:

  1. Перейдите на страницу Создание приложения.

  2. Заполните поля:

    • Название вашего сервиса;

    • Иконка сервиса — опционально;

    • Платформы приложения — добавьте одну или несколько платформ;

    • Redirect URL — укажите https://oauth.yandex.ru/verification_code;

    • Доступ к данным — укажите adfox:api;

    • Почта для связи — опционально.

  3. Нажмите Создать приложение и скопируйте его ClientID .

  4. Добавьте скопированный ClientID в ссылку вида https://oauth.yandex.ru/authorize?response_type=token&client_id=<ID приложения>.

  5. Перейдите по ссылке и на открывшейся странице скопируйте ваш авторизационный токен.

Авторизация

Авторизация происходит при каждом запросе: нужно передавать OAuth-токен, сгенерированный для аккаунта на Яндексе, для каждого метода в HTTP-заголовке Authorization.

Authorization: OAuth <токен>

Пример

curl -H 'Authorization: OAuth 05dd3dd84ff948fdae2bc4fb91f13e22bb1f289ceef0037' \
  https://adfox.yandex.ru/api/v2/reports/metadata

Запросы от разных типов пользователей

Для администратора и ассистентов передавать в запросах параметр ownerId необязательно.

Для запросов от аккаунтов рекламодателя или владельца сайта при каждом запросе передавайте параметр ownerId — идентификатор аккаунта администратора, от имени которого строится отчет.

Эндпоинт

Тип пользователя

Обязательность ownerId

/metadata /available-dates

Администратор / ассистент

Не обязателен. Если передан — должен совпадать с вашим ownerId.

/metadata /available-dates

Рекламодатель / владелец сайта

Обязателен.

/{taskId} /{taskId}/result

Любой

ownerId не принимают — задача всегда ищется среди задач текущего пользователя.

В GET-запросах ownerId передается как query-параметр:

?ownerId=12345

В POST-запросе ownerId передается в теле запроса как целое положительное число.

Предыдущая