В этом руководстве Вы найдете базовую информацию о принципах работы API "Корпоративная лига" и о подготовке к его использованию.

API (application programming interface) — это посредник между разработчиком приложений и какой-либо средой, с которой это приложение должно взаимодействовать. API упрощает создание кода, поскольку предоставляет набор готовых классов, функций или структур для работы с имеющимися данными.

API "Корпоративная лига" — это интерфейс, который позволяет получать информацию из базы данных с помощью http-запросов к специальному серверу. Вам не нужно знать в подробностях, как устроена база, из каких таблиц и полей каких типов она состоит — достаточно того, что API-запрос об этом «знает». Синтаксис запросов и тип возвращаемых ими данных строго определены на стороне самого сервиса.

Например, для получения данных о чемпионате с идентификатором 124 необходимо составить запрос такого вида:

https://api.cliga.ru/v1/championats/124

Рассмотрим отдельно все его составляющие.

• http:// — протокол соединения.
• api.cliga.ru — адрес API-сервиса.
• v1 — версия API.
• championat — название метода API "Корпоративная лига". Методы представляют собой условные команды, которые соответствуют той или иной операции с базой данных — получение информации, запись или удаление.
• /124 — параметры запроса. После названия метода нужно передать его входные данные (если они есть) — как обычные GET-параметры в http-запросе.

В ответ сервер вернет JSON-объект с запрошенными данными (или сообщение об ошибке, если что-то пошло не так). JSON — это формат записи данных в виде пар «имя свойства»: «значение».

Ответ на наш запрос выглядит так:

[{"id":124,"name":"Чемпионат России"}]

Структура ответа каждого метода также строго задана, и при работе с API Вы заранее знаете, что в поле id придет число, а в поле name — строка. Такие правила оговариваются на страницах с описанием метода и соответствующих объектов, которые он возвращает в ответе.

Перечень API-методов.