Доступ

  1. Получение доступа к API ADFOX
  2. Доступ к API для разных типов пользователей
  3. Смена пароля
  4. Права доступа для ассистентов API

Получение доступа к API ADFOX

Чтобы получить доступ к API, необходимо зарегистрировать аккаунт в ADFOX.

Если аккаунт в ADFOX уже есть, то можно использовать имеющийся логин для запросов к API.

Регистрация аккаунта

Для бесплатной регистрации аккаунта обратитесь в отдел продаж: accounts@adfox.ru или заполните форму на сайте.

После рассмотрения Вашего обращения, специалисты предоставят доступ к системе:

  • логин администратора;
  • пароль — на указанный адрес электронной почты придет письмо с инструкцией по созданию пароля.

Логин и пароль можно использовать для доступа к системе через веб-интерфейс и через API.

Новым клиентам предоставляется бесплатный демо-аккаунт для знакомства с системой. Он даёт право пользоваться системой в течение 30 дней без ограничений возможностей по настройке и показу рекламы.

За несколько дней до окончания действия демо-аккаунта на адрес электронной почты администратора аккаунта будет выслано письмо о необходимости подписания договора.

После оформления документов демо-аккаунт переводится в активный и вы можете продолжать работать с прежним доступом. Все настройки, созданные в аккаунте в демо-режиме, будут сохранены.

Доступ к API для разных типов пользователей

С каждым аккаунтом может быть связан только один доступ администратора — он был выдан при регистрации аккаунта

Администратор имеет полный набор прав по управлению рекламой и настройкой аккаунта, как в веб-интерфейсе, так и в API.

Администратор может создавать несколько типов пользователей с различным набором прав доступа к API:

  • Ассистент — имеет тот набор прав по управлению рекламой, который ему разрешит администратор в настройках пользователя. Не имеет прав по настройке аккаунта.
  • Ассистент API — имеет набор прав, указанных для него администратором аккаунта. Подробнее о правах и доступах к методам смотрите таблицу.
  • Рекламодатель — имеет права только по получению отчетов по собственным рекламным кампаниям.
  • Владелец сайта — имеет доступ в API только к методу получения списка баннеров.

Смена пароля

Срок действия пароля — один год.

После истечения срока действия пароля в каждом ответе API возвращается ошибка -1000 с дополнительным полем secure_token.

Пример ответа API после истечения срока действия пароля:

<response>
  <status>
   <code>-1000</code>
   <error>Password is inactive. Create new password.</error>
   <secure_token>9f9fdba6b46c26df7968ab960fec85421</secure_token>
  </status>
  <message>Уважаемые клиенты, ваш пароль устарел, пожалуйста, &lt;a href="/changePasswordForm.php">смените пароль&lt;/a> на более сложный.</message>
</response>

Чтобы сменить пароль, необходимо перенаправить пользователя POST-запросом на URL:

https://auth.adfox.ru/password

POST-запрос должен содержать следующие поля:

  1. secure_token=<secure_token> — полученный в ответе от API защитный код;
  2. account=<account> — логин пользователя, для которого необходимо сменить пароль.

После смены пароля вычислите хеш-функцию sha256 от пароля и в дальнейшем используйте новый хеш пароля для авторизации в запросах к API.

Права доступа для ассистентов API

С помощью ассистентов API можно предоставить сотрудникам доступ к API ADFOX с определенным набором прав:
  • RO — только чтение данных: получение списков (действия list, utility, info, listActiveBanners, listValues), получение отчетов (report);
  • RW — работа с объектами (добавление, редактирование, удаление): настройки аккаунта, сайтов, кампаний, баннеров. Запрещены только действия с пользователями (advertiser, assistant, webmaster);
  • RW + manage users – полный доступ к аккаунту.

Создавать и управлять ассистентами API может только администратор аккаунта из веб-интерфейса.

Контекст (object) Действие (action) Имя объекта действия (actionObject) RO RW RW + MU
account
add
advertiser - - +
adNetworkWebsite - + +
assistant - - +
banner - + +
bannerType - + +
campaign - + +
category - + +
place - + +
position - + +
superCampaign - + +
tracingPoint - + +
webmaster - - +
website - + +
zone - + +
delete
assistant - - +
banner - + +
bannerType - + +
campaign - + +
category - + +
place - + +
superCampaign - + +
template - + +
tracingPoint - + +
user - - +
website - + +
zone - + +
list + + +
modify - + +
report + + +
changePassword - - +
auth + + +
utility + + +
adNetwork - - -
adNetworkWebsite - - -
advertiser
modify - - +
assistant
modify - - +
banner
info + + +
modify - + +
target - + +
bannerType
list + + +
modify - + +
updateDefaultBanner - + +
campaign
additionalUsers - + +
clone - + +
info + + +
list + + +
modify - + +
placing - + +
target (targetPlace, targetWebsite, targetZone) - + +
upload - + +
placement
info + + +
position
modify - + +
place
info + + +
listActiveBanners + + +
modify - + +
updateDefaultBanner - + +
superCampaign
additionalUsers - + +
modify - + +
tracingPoint
getCode + + +
modify - + +
userCriteria
addValue - + +
listValues + + +
modify - + +
modifyValue - + +
removeValue - + +
webmaster
info + + +
modify - - +
website
modify - + +
zone
modify - + +