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

Последнее обновление: 29 сентября 2025 г.

Введение

API ИноМаркер предоставляет programmatic доступ к реестрам и функции анализа текста. Наш API построен на принципах REST, использует стандартные HTTP-методы и возвращает все ответы в формате JSON.

Базовый URL для всех запросов v1: https://inomarker.ru/api/v1

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

Все запросы к API должны быть аутентифицированы с помощью API-ключа. Вы можете сгенерировать и управлять вашими ключами в личном кабинете на странице профиля.

Ваш API-ключ должен передаваться в HTTP-заголовке Authorization с префиксом Bearer.

Authorization: Bearer YourSecretApiKeyHere

Обработка ошибок

API использует стандартные HTTP-коды состояния для индикации успеха или неудачи запроса. Ответы с ошибками (в диапазоне 4xx) всегда содержат JSON-объект с ключом message или error, описывающим причину.

Пример ответа с ошибкой (401 Unauthorized):

{
    "message": "API token is missing."
}

Основные коды ошибок:

Код Описание Причина
401 Unauthorized Ошибка аутентификации Ваш API-ключ отсутствует, недействителен или был отозван.
402 Payment Required Требуется оплата У вас нет активной подписки для выполнения этого действия.
422 Unprocessable Entity Ошибка валидации Тело вашего запроса содержит некорректные данные (например, отсутствует обязательное поле `text`).
429 Too Many Requests Превышен лимит Вы исчерпали свой лимит (например, по количеству символов) или отправляете слишком много запросов в минуту.
5xx Server Error Ошибка сервера Произошла внутренняя ошибка на нашей стороне. Пожалуйста, попробуйте позже.

Лимиты запросов

Для защиты от злоупотреблений, к API применяется ограничение в 60 запросов в минуту с одного IP-адреса. При превышении этого лимита вы получите ответ с кодом 429 Too Many Requests.

Эндпоинты

GET /balance

Возвращает текущий остаток символов для проверки текста по вашей активной подписке.

Пример успешного ответа (200 OK):

{
    "characters_limit": 98540
}

Пример для безлимитного тарифа:

{
    "characters_limit": "unlimited"
}

POST /check-text

Анализирует переданный текст, находит и маркирует в нем упоминания из реестров с указанием юридически корректной формулировки.

Параметры (JSON body):

textstringRequiredТекст для проверки.

Пример запроса (cURL):

curl -X POST "https://inomarker.ru/api/v1/check-text" \
-H "Authorization: Bearer YourSecretApiKeyHere" \
-H "Content-Type: application/json" \
-d '{"text": "В тексте упоминается Федоров Мирон Янович."}'

Пример успешного ответа (200 OK):

{
    "marked_text": "В тексте упоминается Федоров Мирон Янович (Перечень лиц, в отношении которых имеются сведения об их причастности к деятельности иностранного агента...).",
    "found_entities": [
        {
            "name": "Федоров Мирон Янович",
            "type": "agents"
        }
    ],
    "characters_used": 41,
    "characters_limit": 99959
}

GET /agents

Возвращает полный список всех активных иноагентов в виде простого JSON-массива строк.

Пример успешного ответа (200 OK):

[
    "Иванов Иван Иванович",
    "ООО «Ромашка»",
    ...
]

GET /extremists

Возвращает полный список всех активных организаций, признанных экстремистскими.

GET /terrorists

Возвращает полный список всех активных организаций, признанных террористическими.