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

Об этом API

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

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

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

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

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

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

Пример:

(это пример с минимальным количеством параметров)

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 целесообразно использовать для реализации постраничного вывода результатов поиска.

Пример запроса к серверу со всеми параметрами: Этот запрос инструктирует API искать предложения, содержащие слово dictionary, в англоязычном корпусе. Выдать результат в формате jsonp, 15 записей, начиная с 10-й. Искать предложения не короче 150 и не длиннее 500 символов.

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

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

Параметры, возвращаемые в ответе сервера:

res	oк в случае успешного выполнения запроса, error - в случае ошибки
info	Описание ошибки в случае ошибки при выполнении запроса
quota_daily	Дневная квота запросов для данного ключа API
quota_daily_used	Объем использованной квоты за текущий день
lang	Язык текстового корпуса, в котором произведен поиск
time	Время, за которое был исполнен запрос, в миллисекундах
query	Искомый текст
from	Порядковый номер записи, с которой начинать выдачу результатов
size	Максимальное количество результатов в ответе сервера
gte	Минимальная длина предложения
lte	Максимальная длина предложения
hits	Содержит найденные предложения в виде записей со следующей структурой: article_id ID статьи на сайте Pressmon.com len Длина текущего предложения (количествово символов) country Код страны источника публикации source Название источника публикации pub_day День публикации pub_month Месяц публикации pub_year Год публикации title Заголовок статьи body Текст найденного предложения url URL статьи, содержащей найденное предложение

Пример ответа сервера с сообщением об ошибке:
Пример ответа сервера при успешном выполнении запроса:

Публичный и секретный ключи 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 - онлайн-словари разных языков