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

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

Получить персональный 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": "\u0414\u043e\u0441\u0442\u0443\u043f \u043a API \u0437\u0430\u043f\u0440\u0435\u0449\u0451\u043d.",
            "status": 401
        }
    ]
}

Коды состояния HTTP

200 Запрос выполнен успешно

400 Некорректный запрос — обязательные параметры отсутствуют или указаны неверно

401 Не авторизован — API-ключ отсутствует или недействителен

404 Запрашиваемый ресурс не найден

429 Слишком много запросов — превышен лимит частоты обращений

500 Внутренняя ошибка сервера — проблема на нашей стороне

Все результаты работы API выводятся в часовом поясе UTC, если не указано иное.

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

Мои сайты

SEO-аудиты

Архив аудитов

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

Свои домены

Мои команды

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

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

История платежей

Логи