Документация API

Узнайте, как подключиться и интегрироваться с нашим API.

 
Получите свой ключ API

Аутентификация

Все эндпоинты API требуют отправки ключа API методом Bearer Authentication.

Authorization: Bearer {api_key}
curl --request GET \
--url 'https://serpmax.ru/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Ошибки

Наш API использует стандартные коды состояния HTTP для обозначения успешности или неудачи запроса.

{
    "errors": [
        {
            "title": "\u0423 \u0432\u0430\u0441 \u043d\u0435\u0442 \u0434\u043e\u0441\u0442\u0443\u043f\u0430 \u043a API.",
            "status": 401
        }
    ]
}
200 Запрос успешно выполнен
400 Плохой запрос - Обязательные параметры отсутствуют или недействительны
401 Неавторизован - Ключ API отсутствует или недействителен
404 Запрашиваемый ресурс не найден
429 Слишком много запросов - Превышен лимит скорости
500 Внутренняя ошибка сервера - это означает, что проблема на нашей стороне
Все результаты API-эндпоинтов работают с часовым поясом UTC, если не указано иное.
Пользователь
Сайты
Аудиты
Архивные аудиты
Обработчики уведомлений
Пользовательские домены
Команды
Участники команды
Участник команд
Платежи аккаунта
Журнал аккаунта