REST API

Jump to bottom Edit New page

Morfeusys edited this page Nov 5, 2014 · 4 revisions

Чтобы получить данные из пользовательского запроса, необходимо отправить его в HTTP GET запросе вида:

http://markup.dusi.mobi/api/text?lang=<язык текста>&text=<текст>

В ответ сервис вернет JSON следующего формата:

{ "string": "<исходный текст запроса>", "tokens": <массив сущностей, найденных в тексте> }

Параметры запроса

text - текст запроса (обязателен)
lang - язык (например, ru)
timestamp - текущее время пользователя в миллисекундах (необходимо для правильного преобразования дат и времени)
offset - смещение времени UTC относительно времени пользователя в минутах (необходимо для правильного преобразования дат и времени)

Формат ответа

Сервис возвращает JSON со следующими полями:

string - исходный текст запроса
tokens - массив найденных сущностей

Если сервис не обнаружил ни одной сущности, отличной от типа Text, то будет возвращен пустой массив

Формат сущностей

Каждая сущность - это JSON объект со следующими полями:

type - тип сущности (например, Date, Time, City или Text)
substring - подстрока в исходной строке, соответствующая сущности
value - данные, выделенные из сущности (формат специфичен для каждого конкретного типа)
formatted - опционально - форматированное представление данных (например, "01.10.2014" для даты)