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

Это документация по доступным API-эндпоинтам, построенным на архитектуре REST. Все эндпоинты возвращают JSON-ответ со стандартными HTTP-кодами и требуют аутентификации Bearer через API-ключ.

Получите свой собственный API-ключ

Базовый URL

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

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

Authorization: Bearer {api_key}

Пример

curl --request GET \
--url 'https://seofa.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, если не указано иное.

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

Сайты

Анализы

Архивные анализы

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

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

Журнал действий