Base URL
Аутентификация
Все запросы требуют заголовокAuthorization с API-ключом. Ключи создаются в личном кабинете партнёра: Tools -> API (partners.onlytraffic.com/tools/api). У аккаунта может быть до 5 именованных ключей, каждый с доступом Full или Read-only. Ключ показывается один раз при создании, поэтому сразу скопируйте его. Подробности на странице Аутентификация.
Коды ошибок и подробная настройка описаны на странице Аутентификация.
Эндпоинты
Запись данных
Ключ с доступом Full читает и пишет; ключи Read-only получают403 на эндпоинтах записи. Эндпоинты записи делают ровно то, что вы можете сделать в кабинете, с теми же сообщениями валидации. Идентификаторы в запросах на запись — публичные id (revc_… для кампаний, cplo_… для CPL-кампаний); числовые внутренние id отклоняются с 404. Каждая запись возвращает обновлённый объект в data, в том же формате, что и соответствующий списочный эндпоинт.
Правила описаны на странице Write API, тела запросов — на страницах отдельных эндпоинтов.
Пагинация
Все списочные эндпоинты принимаютoffset и limit как query-параметры. У эндпоинтов статистики пагинации нет. Вместо неё они принимают период from / to: Unix timestamp или дату Y-m-d, не более 366 дней между ними. У CPC Categories пагинации тоже нет: весь каталог приходит одним ответом.
Форматы дат
У каждого поля с временной меткой есть два варианта:- Строка ISO 8601 (
*_at), например"2024-06-01T12:00:00+00:00" - Целое число Unix timestamp (
*_at_ts/*_ts), например1717243200
Формат ответа
Все ответы возвращают HTTP200. Фактический статус находится в поле status.