АПИ

Сервис «Главред» находит в тексте стоп-слова: языковой мусор, рекламные и журналистские штампы, признаки плохого синтаксиса и канцелярит. Без этих слов текст станет понятным, коротким и информативным.

Чтобы проверить текст на стоп-слова, обычно автор заходит на сайт glvrd.ru, вставляет текст в окно Главреда, редактирует и забирает обратно в свой редактор. Это терпимо, когда автор проверяет текст раз в день, но неудобно, когда он постоянно работает с текстом.

Представляем АПИ Главреда для разработчиков. АПИ помогает встроить Главред в сайты, админки и визивиг-редакторы, чтобы авторы проверяли текст, не переключаясь на glvrd.ru. Это полезно в блогах, редакционных админках и ЦМС.


Возможная реализация плагина Эгеи на базе АПИ Главреда

Что такое АПИ

АПИ — это технический язык общения с сервером Главреда. Разработчики используют АПИ, чтобы обмениваться данными с другими программами.

АПИ — еще не приложение. Чтобы Главред появился в редакционной админке, на сайте или в движке блогов, разработчик создает на базе АПИ собственную программу — плагин. Плагин отвечает за то, как выделять ошибки и выводить объяснения и как это все работает.

Где плагины?

В разделе «Приложения» на сайте — там мы собираем плагины и приложения, которые нам присылают.

Мы приглашаем разработчиков создавать плагины для Вордпресса, Эгеи, Битрикса, Гуглдока, Тумблера, ЖЖ и любых других программ, которые работают с текстом. Будем рады опубликовать ваши плагины на сайте Главреда. Пишите: mail@glvrd.ru

Если вы ждете плагины Главреда для своей платформы, следите за новостями в рассылке Главреда. Как только у нас появятся интересные плагины, мы вам сообщим. Подписаться…

Подключение

Чтобы подключить АПИ, добавьте в код (можно с https://):

<script src="https://api.glvrd.ru/v1/glvrd.js"></script>

Если захотите использовать родной стиль выделения ошибок, вызовите таблицу стилей, в которой определён класс .glvrd-underline:

<link href="https://api.glvrd.ru/v1/glvrd.css" rel="stylesheet" type="text/css" />

Для работы потребуется доступ в интернет. Скрипт glvrd.js загружайте с серверов Главреда и не сохраняйте скрипт к себе: мы еще отлаживаем механизмы, и скрипт часто меняется.

После подключения у вас появится объект window.glvrd с методами getStatus, proofread и abortProofreading.

glvrd.getStatus(callback)

Асинхронно проверяет статус Главреда и вызывает функцию callback, передавая ей аргумент result вида {status: 'ok'} или {status: 'error', code: '...', message: '...'}. Если статус ok, сервер Главреда готов проверить текст. Всегда проверяйте статус в начале работы.

glvrd.proofread(text, callback)

Асинхронно проверяет текст text и вызывает функцию callback, передавая ей аргумент result вида:

{ status: 'ok', score: '...', fragments: [ { start: ..., end: ..., url: '...', hint: { title: '...', description: '...' }, }, ... ] }

или

{ status: 'error', code: '...', message: '...'}

Если result.status == 'ok', то в result.fragments содержатся найденные Главредом фрагменты текста, заданные начальной и конечной позицией start и end и сопровождаемые пояснением hint. В url содержится ссылка на Главред с этим фрагментом.

Как именно выводить ответ Главреда — остается на ваше усмотрение, однако мы рекомендуем подсвечивать ошибки в тексте и выводить описание ошибок справа от текстового редактора, чтобы было похоже на сайт Главреда. Так пользователям проще привыкнуть к новой среде. Чтобы ваши стили были похожи на родные стили Главреда, используйте таблицу glvrd.css

glvrd.abortProofreading()

Останавливает запущенную проверку текста, если она еще не закончилась.

glvrd.getScore(textsWithFragments)

Синхронно и без обращения к серверу вычисляет количество баллов по шкале Главреда. Аргумент textsWithFragments — массив вида:

[ {text: '...', fragments: [...]}, ... ]

где text — это текст, а fragments — результат проверки, полученной от функции proofread. Возвращает число от 0 до 10, округлённое до одного знака после запятой.

Функция пригодится, чтобы посчитать общий балл текста, части которого передавались в proofread по отдельности. Например, вы сделали текстовый редактор с проверкой Главреда, и он начинает тормозить на большом тексте. Тогда отправляете на проверку только измененные части, а общий балл считаете локально через getScore.

Ошибки, которые выдают getStatus и proofread

На стороне клиента
code message Описание
failed_request Запрос неудачен Возможно, пропал интернет или сервер Главреда перегружен
unreadable_response Пришел непонятный ответ от сервера Возможно, сервер Главреда подменили
На стороне сервера
bad_script Некорректный скрипт Скрипт скачан не с сервера Главреда
script_expired Истёк срок действия скрипта Скрипт был загружен с сервера Главреда больше 48 часов назад

Пример использования

<html> <body> <script src="https://code.jquery.com/jquery-2.1.4.min.js"></script> <script src="https://api.glvrd.ru/v1/glvrd.js"></script> <textarea id="text">Например, пример.</textarea> <script> function InitButtons() { $('#text').after( '<br />', '<button id="proofread">Проверить</button>', '<button id="abort" disabled>Отменить проверку</button>' ); $('button#proofread').click(function() { var text = $('textarea#text').val(); glvrd.proofread(text, function(result){ if(result.status == 'ok') { console.log('Score', result.score); console.log('Fragments', result.fragments); } else { alert(result.message); } }); }) $('button#abort').click(function() { glvrd.abortProofreading(); }) } if(!glvrd) { alert('Главред не загружен'); } else { glvrd.getStatus(function(result) { if(result.status == 'ok') { InitButtons(); } else { alert('Главред выключен: ' + result.message); } }) } </script> </body> </html>

Связаться с разработчиком

АПИ Главреда придумал и реализовал Анатолий Буров. Пишите ему, если появились вопросы о внедрении и использовании АПИ Главреда: admin@glvrd.ru.

Если вы сделали плагин и хотите опубликовать его на сайте Главреда, напишите Максиму Ильяхову: mail@glvrd.ru.

Если вы хотите, чтобы скорее появился плагин для вашего текстового редактора, пришлите ссылку на эту страницу знакомому разработчику.


Главред

Помогает очистить текст от словесного мусора, проверяет на соответствие информационному стилю. Расскажите о Главреде всем, кто пишет:

Вконтакте
Гугл-плюс


 

Полезная рассылка о сильном тексте. Уроки, советы и примеры каждую неделю, без спама.