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

Сервис TextGears API позволяет использовать технологии проверки языка в любом стороннем программном продукте. От простых сайтов и мобильных приложений до сложных Enterprise-решений.

Веб-плагин TextGears

Самым простым способом подключения проверки текста является установка TextGears Plugin на нужные страницы сайта. Для этого достаточно разместить код плагина в HTML страницы. Подойдет любое место между тегами <body> и </body>. После сохранения страницы в каждом поле для ввода большого текста появится автоматическая проверка, выделяющая обнаруженные ошибки и предлагающая варианты их исправления. По умолчанию, процесс проверки происходит автоматически раз в несколько секунд. Вы можете отключить ее и производить только в те моменты, когда это необходимо. Например, только при нажатии на кнопку «Проверить».

<script>
var agcOptions = {
   key: 'e55abf73',
   //auto: "textarea" ,
   forms: [{
      field: '#editor',
      button: '#agc_check'
   }],
   callbacks: {
      changed: null,
      checkStart: null,
      checkDone: null,
      checkAlways: null
   }
};
(function(d, w, s, id) {
   var js, tjs = d.getElementsByTagName(s)[0];
   if (d.getElementById(id)) return;
   js = d.createElement(s); js.id = id;
   js.src = window.jQuery?"//api.textgears.com/a/grammar/1/0.js":"//api.textgears.com/a/grammar/1/0j.js";
   f = function () { tjs.parentNode.insertBefore(js, tjs); };
   if (w.opera == "[object Opera]") {
      d.addEventListener("DOMContentLoaded", f, false);
   } else { f(); }
})(document, window, 'script', 'tg-agcjs');</script>

Ручная настройка плагина

При необходимости, плагин можно настроить под свои нужды. Если у вас есть вопросы или вам нужна помощь в установке или настройке плагина, обращайтесь. Мы обязательно вам поможем. Вы можете указать конкретные поля форм, в которых проверка необходима. Для этого в коде инициализации плагина указывается селектор с перечислением нужных элементов.

Непосредственная работа с API

Работа с TextGears API осуществляется посредством GET или POST запросов, содержащих необходимые функции и параметры их запуска. Запросы могут осуществляться по протоколу HTTP или HTTPS. Форматом выходных данных является JSON. Статус ответа сервера передается в атрибуте status возвращаемого объекта. Атрибут status может принимать значение ok или error. При возникновении каких-либо ошибок во время выполнения запроса, кроме status=1 отправляется номер ошибки и её краткое описание краткое описание на английском языке.

Запрос

https://api.blabroom.ru/check.php?text=My mother are a doctor, but my father is a angeneer.

Ответ

{
  result : true,
  errors :   {
    0 :     {
      id : 'eb0e3f74',
      offset : 0,
      length : 13,
      bad : 'My mother are',
      better :       {
        0 : 'My mother is',
        1 : 'My mothers are'
      }
    },
    1 :     {
      id : 'eb0e3f71',
      offset : 41,
      length : 1,
      bad : 'a',
      better :       {
        0 : 'an'
      }
    },
    2 :     {
      id : 'eb0e3f72',
      offset : 43,
      length : 8,
      bad : 'angeneer',
      better :       {
        0 : 'engineer',
        1 : 'engender'
      }
    }
  }
}