Документация 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 \u043f\u0440\u0430\u0432 \u0434\u043e\u0441\u0442\u0443\u043f\u0430 \u043a API.",
            "status": 401
        }
    ]
}
200 Запрос выполнен успешно
400 Неверный запрос — Отсутствуют или некорректны обязательные параметры
401 Не авторизован — API-ключ отсутствует или недействителен
404 Запрашиваемый ресурс не найден
429 Слишком много запросов — Превышен лимит скорости
500 Внутренняя ошибка сервера — это означает проблему на нашей стороне
Все результаты работы конечных точек API соответствуют часовому поясу UTC, если не указано иное.
Пользователь
Мои сайты
Аудиты
Архив аудитов
Обработчики уведомлений
Подключение своих доменов
Лог событий