На этой странице вы найдете базовую информацию о принципах работы API DayHub и о подготовке к его использованию.
API (application programming interface) — это посредник между разработчиком приложений и какой-либо средой, с которой это приложение должно взаимодействовать. API упрощает создание кода, поскольку предоставляет набор готовых классов, функций или структур для работы с имеющимися данными.
API DayHub — это интерфейс, который позволяет получать информацию из базы данных xtty.ru с помощью http-запросов к специальному серверу. Вам не нужно знать в подробностях, как устроена база, из каких таблиц и полей каких типов она состоит — достаточно того, что API-запрос об этом знает. Синтаксис запросов и тип возвращаемых ими данных строго определены на стороне самого сервиса.
Например, для получения данных о каком-либо событии с идентификатором 220 необходимо составить запрос такого вида:
https://api.xtty.ru/method/date.get?date_id=220
Методы представляют собой условные команды, которые соответствуют той или иной операции с базой данных — получение информации, запись или удаление. Например, date.get — метод для получения информации о событии, day.get — метод для получения любого дня года, daydate.get — метод для получения событий любого дня года.
Все методы разделены на секции. Например, для работы с событиями вам нужны методы секции date, для работы с личностями — person, и так далее.
После названия метода нужно передать его входные данные (если они есть) — как обычные GET-параметры в http-запросе. В нашем примере мы сообщаем серверу, что хотим получить данные о событии с date_id=220.
В ответ сервер вернет JSON-объект с запрошенными данными (или сообщение об ошибке, если что-то пошло не так). JSON — это формат записи данных в виде пар «имя свойства»: «значение».
Ответ на наш запрос выглядит так:
{
"ansdate": [
{
"date_id": 220,
"date_title": "В космос полетел первый человек",
"date_day": "12.04.1961"
}
]
}
Структура ответа каждого метода также строго задана, и при работе с API вы заранее знаете, что в поле date_id придет число, а в поле date_title — строка. Такие правила оговариваются на страницах с описанием метода и соответствующих объектов, которые он возвращает в ответе.
Список доступных методов для исторических событий:
| date_id | Возвращает ID события |
| date_title | Возвращает заголовок события |
| title_i | Возвращает заголовок вместе с количеством лет, когда произошло событие |
| image | Возвращает обложку события |
| image_source | Возвращает источник обложки без https:// |
| image_source_fix | Возвращает источник обложки с https:// |
| content | Возвращает массив с описанием события |
| day | Возвращает день события (число от 1 до 31) |
| month | Возвращает месяц события (число от 1 до 12) |
| date_day | Возвращает месяц события в формате строки |
| date_day_v | Возвращает месяц события в родительном падеже |
| year | Возвращает год события (число от 1000 до 2022), причем последний элемент всегда равен текущему году. |
| parent_day | Возвращает массив с полной датой |
| parent_people | Возвращает массив со связанными личностями события |
| agestop | Возвращает строку о вхождении события в категорию "18+" |
| block_date | Возвращает строку о запрещенных организациях в России, если упоминания о таковых присутствуют в событии |
| tag_date | Возвращает массив с тегами события |
| hits_count | Возвращает число с количеством просмотров |
В данный момент мы предоставляем возможность использования API только по запросу - для электронных библиотек, вузов, учебных заведений и др.
Обратите внимание: разработчики проекта не оказывают услуги по настройке API для вашего проекта, не дорабатывают и не изменяют структуру API по запросу.