Главная      API      Документация      Демо     

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



Об этом API
Основные принципы работы
Параметры запроса к серверу
Формат ответа сервера
Публичный и секретный ключи API
Квота на количество запросов
Ссылка на наш сайт
Сайты, на которых используется данный API


Об этом API

Данный REST-ориентированный программный интерфейс позволяет возвращать предложения из прессы и литературы на разных языках, содержащие заданное слово или словосочетание. Таким образом Вы можете получить примеры употребления данного слова в различных контекстах.


Это может быть полезно для сайтов словарей и других лингвистических ресурсов, предполагающих поиск слов.


На данный момент API позволяет производить поиск в корпусах текстов на следующих языках:

  • Английский
  • Испанский
  • Итальянский
  • Немецкий
  • Русский
  • Французский



Основные принципы работы

1. Отправка запроса серверу.

Пример:

http://www.pressmon.com/api?q=word-to-search&key=YOUR_API_KEY
(это пример с минимальным количеством параметров)


2. Получение ответа от сервера в формате JSON и интерпретация результатов.

Параметры запроса к серверу

qИскомое слово или словосочетание. Обязательный параметр
keyКлюч API (публичный или секретный). Обязательный параметр
lЯзык текстового корпуса, в котром требуется произвести поиск. Возможные значения:
en - английский
es - испанский
it - итальянский
de - немецкий
ru - русский
fr - французский

По умолчанию - en
fromПорядковый номер записи, с которой начинать выдачу результатов.
По умолчанию - 0.
sizeМаксимальное количество результатов в ответе сервера.
По умолчанию - 10.
Минимальное значение - 1, максимальное - 100.
formatФормат данных, в котором будет возвращен результат поиска. Допустимые значения:
json
jsonp
Для кроссдоменных запросов с использованием библиотеки jQuery необходимо использовать формат jsonp. По умолчанию - json.
gteМинимальная длина фразы. Будут найдены только предложения не короче этого значения. По умолчанию - 0.
lteМаксимальная длина фразы. Будут найдены только предложения не длиннее этого значения. По умолчанию - 10000.

Параметры from и size целесообразно использовать для реализации постраничного вывода результатов поиска.


Пример запроса к серверу со всеми параметрами:
http://www.pressmon.com/api?q=dictionary&key=YOUR_API_KEY&l=en&from=10&size=15&gte=150&lte=500&format=jsonp
Этот запрос инструктирует API искать предложения, содержащие слово dictionary, в англоязычном корпусе. Выдать результат в формате jsonp, 15 записей, начиная с 10-й. Искать предложения не короче 150 и не длиннее 500 символов.

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

Сервер возвращает ответ в формате JSON или JSONP (в зависимости от значения параметра format).
В случае успешного выполнения запроса параметр res содержит значение ok, в противном случае - error.
В случае значения error описание ошибки содержится в параметре info.

Параметры, возвращаемые в ответе сервера:
res в случае успешного выполнения запроса, error - в случае ошибки
infoОписание ошибки в случае ошибки при выполнении запроса
quota_dailyДневная квота запросов для данного ключа API
quota_daily_usedОбъем использованной квоты за текущий день
langЯзык текстового корпуса, в котором произведен поиск
timeВремя, за которое был исполнен запрос, в миллисекундах
queryИскомый текст
fromПорядковый номер записи, с которой начинать выдачу результатов
sizeМаксимальное количество результатов в ответе сервера
gteМинимальная длина предложения
lteМаксимальная длина предложения
hits Содержит найденные предложения в виде записей со следующей структурой:

article_idID статьи на сайте Pressmon.com
lenДлина текущего предложения (количествово символов)
countryКод страны источника публикации
sourceНазвание источника публикации
pub_dayДень публикации
pub_monthМесяц публикации
pub_yearГод публикации
titleЗаголовок статьи
bodyТекст найденного предложения
urlURL статьи, содержащей найденное предложение

Пример ответа сервера с сообщением об ошибке:
{ "res": "error", "info": "Quota exceeded" }

Пример ответа сервера при успешном выполнении запроса:
{
"res":"ok",
"from":"0",
"size":"10",
"quota_daily_used":"217",
"quota_daily":"5000",
"lang":"en",
"time":"389",
"query":"dictionary",
"collection":"sentences_en",
"max_score":"4.2429724",
"hits_total":"50",
"scope":"body",
   "hits":[

{
"country":"",
"source":"Korean News",
"pub_day":"21",
"score":"4.2429724",
"body":"A new window will open with a dictionary definition or encyclopedia entry. ",
"pub_year":"2008",
"id":"5303ad88b92aa6da710e54fa",
"article_id":"453",
"len":"22",
"url":"http://www.pressmon.com/-lang-/a/en/453",
"pub_month":"5",
"title":"ELECTION GUIDE 2008 \""
},
{
"country":"",
"source":"Korean News",
"pub_day":"18",
"score":"4.073505",
"body":"The dictionary contains a vocabulary of over 402,000 words. ",
"pub_year":"2008",
"id":"5303a9efb92aa6da7109771f",
"article_id":"850",
"len":"42",
"url":"http://www.pressmon.com/-lang-/a/en/850",
"pub_month":"1",
"title":"COMPREHENSIVE KOREAN DICTIONARY SEES LIGHT"
}
   ]

     }



Публичный и секретный ключи API

Данный API предусматривает два вида идентификационных ключей: публичный и секретный. Оба ключа доступны в Вашем аккаунте сразу после регистрации.

Для публичного ключа, в отличие от секретного, Вы можете задать перечень доменов, с которых разрешено направлять запросы к API с использованием данного ключа. Мы рекомендуем использовать публичный ключ в приложениях, запускаемых на стороне клиента (любой пользователь может видеть ключ, но использоваться он может только на обозначенных Вами доменах), а секретный - на стороне сервера (ключ может использоваться на любом домене, но не доступен другим пользователям).

Вы в любой момент можете сменить ключи.

Квота на количество запросов

Мы предоставляем бесплатную квоту на запросы к API в 2 000 запросов в день. При превышении лимита будет выдаваться сообщение об ошибке "quota exceeded".

В Вашем аккаунте Вы можете видеть, сколько времени осталось до восстановления дневной квоты.

Если Вам не хватает этой квоты, пожалуйста, напишите нам.

Ссылка на наш сайт
Обязательным условием использования нашего API на Ваших сайтах или в приложениях является ссылка на сайт www.pressmon.com на все страницах, на которых демонстрируется контент, полученный с использованием нашего API.

Примеры ссылок:
Powered by Pressmon.com
Examples by Pressmon.com
Примеры от Pressmon.com
Ejemplos por Pressmon.com


Сайты, на которых используется данный API

На этих сайтах Вы можете посмотреть, как наш API используется на практике:

www.diccionario.ru - испанско-русский и русско-испанский словарь
www.diclib.com - онлайн-словари разных языков

На главную страницу