Интерфейс API

The API Interface is a representation of the ExoClick API designed to detail available requests, their associated parameters and their expected responses. You can view it from the Admin Panel.

Все запросы API перечислены в соответствующей группе.

Чтобы получить доступ к ограниченным запросам API, необходимо установить токен сеанса. Чтобы установить токен, у вас должна быть действующая учетная запись с требуемым именем пользователя и паролем или токен API. Нажмите на кнопку Войти в правой верхней части экрана и введите имя пользователя и пароль или укажите API-токен. После того как вы нажмете кнопку Войти, будет сделан запрос на вход в API для получения действительного токена сессии. Этот токен будет использоваться для проверки всех запросов API, которые вы хотите сделать в этой сессии.

Чтобы сделать запрос к API, нажмите на группу. Группа раскроется, чтобы показать список доступных запросов. Снова нажмите на нужный запрос. Появится панель с подробной информацией о запросе.

• Тело ответа, если таковое имеется, будет отображаться первым рядом с ответом Content-type**.

• Далее подробно описаны Параметры запроса, обязательные и/или необязательные, а также Тип содержимого, если требуется.

• Затем перечисляются ожидаемые Ответные сообщения.

• Чтобы выполнить запрос, заполните необходимые параметры. Если тело запроса детализировано, щелчок на теле в окне Модель приведет к предварительному заполнению окна параметров телом.

• После того как все необходимые параметры будут заданы, щелчок на кнопке Try it Out приведет к выполнению запроса.

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

  • Первый отображает полный Request URL.
  • Во втором подробно описывается Тело ответа.
  • В третьей части указывается Код ответа.
  • Четвертая часть содержит заголовки ответа.