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

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

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

Базовый URL

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

Все эндпоинты API требуют API-ключ, передаваемый через метод Bearer-аутентификации.

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, если не указано иное.

Пользователь

Сайты

Аудиты

Архивные аудиты

Обработчики уведомлений

Пользовательские домены

Команды

Участники команды

Членство в командах

Платежи аккаунта

Приглашённые регистрации

Логи аккаунта