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

к программному интерфейсу (API) сайта diccionario.ru
для поиска в словарях

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

Об этом API

Данный API позволяет производить поиск в словарях и возвращать найденные слова сразу из всех или только из выбранных словарей.

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

Пример минимального запроса к API:
http://api.diccionario.ru/?key=[YOUR_API_KEY]&q=diccionario

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

Параметр	По умолчанию	Описание
key	-	- Ваш ключ API. Обязательный параметр.
q	-	- искомый текст. Обязательный параметр.
dict	-	- словарь, в котором будет производиться поиск. Как получить список доступных словарей.
format	json	- формат, в котором будет выдан результат запроса. Возможные значения: json, jsonp.
callback	callback	- имя процедуры, которое будет использовано при выдаче результата запроса в формате jsonp.
from	0	- порядковый номер записи, с которой начинать выдачу результатов. Используется для реализации постраничного вывода результатов поиска.
size	10	- максимальное количество результатов в ответе сервера. Минимальное значение - 1, максимальное - 100. Используется для реализации постраничного вывода результатов поиска.

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

http://api.diccionario.ru/?q=diccionario&key=YOUR_API_KEY&dict=join_es_ru&from=10&size=15&format=jsonp

Этот запрос инструктирует API искать слово diccionario, в словаре join_es_ru. Выдать результаты с 1 по 15

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

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

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

res

oк в случае успешного выполнения запроса, error - в случае ошибки

errors

- список ошибок (если res имееь значение error)

quota_daily

- дневная квота запросов для данного ключа API

quota_daily_used

- объем использованной квоты за текущий день

time

- время, за которое был исполнен запрос, в миллисекундах

query

- искомый текст

dicts

- массив, содержащий список словарей, в которых найден искомый текст. Доступно, если в запросе задано значение dict.
Пример записи:
[

{
dict: "join_es_ru", //Идентификатор словаря
doc_count: 17, //Количество найденных словарных статей в данном словаре
priority: 1, //Приоритет данного словаря по сравнению с другими словарями (для возможного использования в целях сортировки на стороне клиента)
lang_l: "spa", //Язык левой части словарной статьи
lang_r: "rus", //Язык правой части словарной статьи
type: "bilingual", //Тип словаря. "bilingual" - двуязычный словарь, "pairs" - параллельный текст
names: [{name: "Diccionario español-ruso", lang: "spa"}, {name: "Испанско-русский словарь", lang: "rus"}] //Название словаря на разных языках
},
{
dict: "join_ru_es",
doc_count: 25,
priority: 1,
lang_l: "rus",
lang_r: "spa",
type: "bilingual",
names: [{name: "Diccionario ruso-español", lang: "spa"}, {name: "Русско-испанский словарь", lang: "rus"}]
}

]

active_dict

Текущий словарь, найденные статьи из которого показаны. Доступно, если задано значение dict.
Пример:
active_dict: {
"dict":"join_es_ru",
"names":[

{name: "Испанско-русский словарь Diccionario.ru", lang: "rus"},
{name: "Diccionario español-ruso por Diccionario.ru", lang: "spa"}
]

}

hits_total

- общее количество найденных словарных статей

hits

Содержит найденные словарные статьи в виде записей со следующей структурой:

id	- ID записи
dict	- словарь, в котором найдена данная словарная статья
l	- левая часть словарной статьи
r	- правая часть словарной статьи
type	- Тип словаря, в котором найдена словарная статья. "bilingual" - двуязычный словарь, "pairs" - параллельный текст
title	- Название параллельного текста. Доступно, если type="pairs"
highlight	- текст левой и/или правой словарной статьи с выделенным искомым фрагментом. Формат записи: { l: [ "[hl]diccionario[/hl] enciclopédico" ], r: [ "энциклопедический словарь - [hl]diccionario[/hl] enciclopédico" ] }

from
size
dict

- "Эхо" запроса. Содержание данных параметров аналогично значениям, переданным в запросе

Пример ответа сервера с сообщением об ошибке:

{ "res": "error", "errors": ["Quota exceeded"] }

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

{
res: "ok",
from: 0,
size: 10,
quota_daily_used: 217,
quota_daily: 500,
dict: "join_es_ru",
time: 389,
query: "diccionario",
hits_total: 1,
active_dict: {

dict: "join_es_ru",
names: [

{ name: "Испанско-русский словарь Diccionario.ru", lang: "rus" },
{ name: "Diccionario español-ruso por Diccionario.ru", lang: "spa" }

]

},
dicts:[

{
dict: "join_es_ru",
doc_count: 7,
lang_l: "spa",
lang_r: "rus",
type: "bilingual",
priority: 1,
names:[

{ name: "Испанско-русский словарь", lang: "rus" },
{ name: "Diccionario español-ruso", lang: "spa" }

]
},
{
dict: "pairs",
doc_count:3,
lang_l: "spa",
lang_r: "rus",
type: "pairs",
priority: 3,
names:[

{ name: "Параллельные тексты", lang: "rus"},
{ name: "Textos paralelos", lang: "spa"}

]
},
{
dict: "join_ru_es",
doc_count:23,
lang_l: "rus",
lang_r: "spa",
type: "bilingual",
priority: 2,
names:[

{"name":"Русско-испанский словарь Diccionario.ru","lang":"rus"},
{"lang":"spa","name":"Diccionario ruso-español Diccionario.ru"}

]
}

],
hits:[

{
id: "56b84e4d8670c07882675898",
dict: "join_es_ru",
lang_l: "spa",
lang_r: "rus",
title: null,
type: "bilingual",
highlight:
{
l: ["[hl]diccionario[/hl] ideolуgico, [hl]diccionario[/hl] de uso"]
},
l: "diccionario ideológico, diccionario de uso",
r: "толковый словарь"
}
]
}

Как получить список доступных словарей

http://api.diccionario.ru/?key=YOUR_API_KEY&action=get_dicts

Добавьте &format=jsonp&callback=callback_name для получения результатов в формате jsonp.

В ответ будет выдан массив 'dicts'.
Пример:

[{
dict: "join_es_ru",
lang_l: "spa",
lang_r: "rus",
dict_priority: 1,
type: "bilingual",
articles_count: 266744,
names: [

{
name: "Испанско-русский словарь Diccionario.ru",
lang: "rus"
},
{
name: "Diccionario español-ruso por Diccionario.ru",
lang: "spa"
}

]
},
{
dict: "join_ru_es",
lang_l: "rus",
lang_r: "spa",
dict_priority:2,
type: "bilingual",
articles_count: 164123,
names: [

{
name: "Русско-испанский словарь Diccionario.ru",
lang: "rus"
},
{
name: "Diccionario ruso-español Diccionario.ru",
lang: "spa"
}

]
},
{
dict: "pairs",
lang_r: "rus",
lang_l: "spa",
dict_priority: 3,
type: "pairs",
articles_count: 6503,
names: [

{
name: "Параллельные тексты",
lang: "rus"
},
{
lang: "spa",
name: "Textos paralelos"
}

] }]

Ключ API

Ключ API доступен в Вашем аккаунте сразу после регистрации.

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

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

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

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

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

Демо на отдельной странице

Standalone demo здесь.

Ссылка на наш сайт

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

Примеры ссылок:
Powered by Diccionario.ru
С помощью словаря Diccionario.ru
Resultados por Diccionario.ru