ГосСловарь API: встройте проверку текстов на запрещенные иностранные слова в ваши процессы

1. Что такое ГосСловарь API?

ГосСловарь API - это сервис, который можно встроить в ваши процессы для автоматической проверки текстов на наличие запрещенных иностранных слов.

Как это работает:

1. Ваш сервис (например, CMS) присылает в ГосСловарь API текст, который надо проверить на запрещенные слова. Обычно это делается до публикации контента на широкую аудиторию.

2. ГосСловарь API разбирает текст на отдельные слова, каждое слово нормализуется (т.е. приводится к начальной форме) и затем проверяется его наличие в одном из нормативных словарей. Список словарей утверждается Государством РФ.

3. Ваш сервис получает ответ, в котором содержится список всех найденных проблемных слов.

Кому это удобно:

• Интернет-магазинам: проверять новые карточки товаров на запрещенные слова.

• Рекламодателям и рекламным площадкам: проверять посты и объявления перед публикацией.

• Сайтам с большим объемом контента: чтобы сэкономить на рабочей силе.

Преимущества использования ГосСловарь API:

• Возможность встроить автоматическую проверку в любой ваш внутренний процесс.

• Высокий приоритет проверок: запросы через API обрабатываются с повышенным приоритетом.

Если вам требуется проверить большое количество текстов, можно согласовать специальные условия. Напишите нам на info@gosslovar-news.ru. Рассмотрим ваш запрос и предложим специальную цену, также можем выделить отдельные мощности, чтобы ускорить обработку.

2. Как начать пользоваться ГосСловарь API

2.1. Шаг 1. Создайте аккаунт

Зарегистрируйтесь на сайте gosslovar.ru — это бесплатно. Вы можете войти через Яндекс, VK, Telegram или по email с паролем.

После регистрации вам автоматически станет доступно 1000 бесплатных проверок слов в день. Этого хватит для тестирования API.

2.2. Шаг 2. Создайте APIKEY

APIKEY — это ваш персональный ключ для доступа к API. Чтобы его получить:

1. Перейдите в Настройки (ссылка доступна в верхнем меню после входа в аккаунт).
2. Найдите секцию «API ГосСловарь».
3. Нажмите кнопку «Создать APIKEY».
4. Ключ будет сгенерирован автоматически. Нажмите «Копировать» чтобы скопировать его в буфер обмена.

Ваш APIKEY выглядит так: GS-abc0913cf.... Сохраните его в надёжном месте.

Если вы забыли ключ — его всегда можно посмотреть в Настройках. Если ключ скомпрометирован — нажмите «Обновить», старый ключ перестанет действовать немедленно.

2.3. Шаг 3. Используйте API

Доступные методы API:

• POST /api/v1/check/word — синхронно проверить одно слово. Результат возвращается сразу.

• POST /api/v1/check/text — запустить проверку текста. Возвращает ID задачи.

• GET /api/v1/results/text — получить результат проверки текста по ID задачи.

Ключ APIKEY передается в заголовке ApiKey каждого запроса:

ApiKey: GS-abc0913cf...

2.4. Шаг 4. Пополните баланс (при необходимости)

Бесплатно доступно 1000 слов в день. Если нужно больше — пополните баланс слов. Проверки через API расходуют слова из общего баланса вашего аккаунта.

Если вам требуется проверить большое количество текстов, напишите нам на info@gosslovar-news.ru. Рассмотрим ваш запрос и предложим специальную цену, также можем выделить отдельные мощности, чтобы ускорить обработку.

3. Описание API

Полное описание API доступно на страницах:

• Swagger UI: интерактивное описание, можно сделать тестовый запрос с вашим APIKEY.

• ReDoc: интерактивное описание в формате ReDoc.

• OpenAPI v3 JSON: спецификация в формате OpenAPI JSON для инструментов автоматической генерации клиента.

Важные особенности:

• Запросы к ГосСловарь API выполняются к хосту https://gosslovar.ru/.

• API проверки текста асинхронный:

  • сначала необходимо создать задачу на проверку текста через /api/v1/check/text и получить в ответ ID этой задачи;

  • затем раз в несколько секунд надо опрашивать (поллить) /api/v1/results/text чтобы получить результат выполнения проверки.

• Ваш APIKEY надо передавать в заголовке ApiKey как есть, например: ApiKey: GS-abc0913cf...

• На данный момент доступны только API для проверки текстов и отдельных слов. По запросу также можно получить доступ к другим API:

  • проверка файлов DOCX, PDF, HTML, TXT, Markdown;

  • проверка URL.

• Проверки, запущенные через API, выполняются в общей очереди задач, но с повышенным приоритетом. Если вы планируете проверять очень большие объемы текста, мы можем создать выделенный сервер под ваши задачи с увеличенной скоростью работы и повышенным SLA. Для этого напишите на info@gosslovar-news.ru.