PeerClick предоставляет API REST-типа, используя безопасные методы HTTPS в качестве транспортного уровня и JSON в качестве формата. Наш центральный API gateway api.peerclick.com используется для обработки всех запросов к соответствующим микро-службам путем включения различных суффиксов каталогов.
Полная документация по API доступна по адресу http://developers.peerclick.com .
Текущие ограничения
Если вы хотите использовать PeerClick API, вы должны помнить, что существует ограничение в 3 запроса API в секунду (для отчетов - 1 запрос в секунду).
Если вы хотите использовать PeerClick API с использованием ключа доступа, вам необходимо сгенерировать его в PeerClick.
Мы оставляем за собой право ограничить или прекратить доступ к API из-за чрезмерного количества запросов или использования. Например, программная генерация тысяч запросов без необходимости, ежеминутное обновление данных, чрезмерная нагрузка на API отчетов в ущерб другим пользователям и т. д. Пользование API действительно позволяет случаться таким ситуациям, в некоторых случаях непреднамеренно. Ни один пользователь не должен использовать API в такой степени, что это влияет на других пользователей или создает нагрузку на инфраструктуру или запросы, превышающие разумные значения.
Анатомия запроса URL
URL запроса может выглядеть следующим образом:
где:
https://api.peerclick.com/v1 - URL базового запроса. URL базового запроса фиксированный и одинаков для всех запросов.
/report - суффикс директория.
?groupBy=campaign&from=2020-01-01 - дополнительные параметры запроса в зависимости от вашего выбора.
Примеры суффиксов директория:
/report
/campaign
/offer
Некоторые запросы также требуют добавления ID компонента после служебного каталога, те, которые четко указаны в нашей документации API через фигурные скобки, например:
/ campaign / {campaignId}
где {campaignId} необходимо заменить на ID кампании из вашей учетной записи PeerClick. Дополнительные параметры затем помещаются в строку запроса URL (после знака вопроса ?) для описания запрошенных данных, например:
?withPages=1
Начало работы с API
Чтобы работать с API, вам нужно:
Получить ключ через панель в разделе Настройки - Безопасность.
Получить токен ключа через POST/auth/access/session.
Залогиниться с этим токеном на https://developers.peerclick.com/.
1. Создание ключа
Чтобы получить ключ доступа:
Зайдите в Настройки.
Перейдите в раздел Безопасность.
В разделе Ключи доступа нажмите кнопку Создать новый ключ.
Назовите ваш ключ и введите пароль вашего аккаунта.
Сохраните ваш ключ в безопасном месте. Все токены, созданные под этим ключом, будут привязаны к нему, и будут утеряны при удалении этого ключа.
2. Создание токена ключа
Перейдите по адресу https://developers.peerclick.com
В разделе Security через POST /auth/access/session создайте токен ключа.
Введите сгенерированные в панели ключи в заданном формате.
Скопируйте полученный токен ключа.
Обращаем внимание, что у токена ключа есть время жизни, по умолчанию равное 86400 секунд, т.е. 1 день. Вы можете изменить lifetime токена ключа при его создании.
3. Авторизация в веб-интерфейсе
Авторизируйтесь на https://developers.peerclick.com/ через кнопку Authorize, введя в поле значение сгенерированного токена.