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

Документация API для разработчиков

API — это аббревиатура от Application Programming Interface, что переводится как интерфейс программирования приложений. Иными словами, это набор правил и инструментов, с помощью которых одна программа может взаимодействовать с другой.

Представьте себе ресторан:

  • меню — это API,
  • вы (программа) хотите еду (данные/функции),
  • официант (API) принимает заказ и передаёт его на кухню (другую систему),
  • потом приносит вам результат — еду (ответ от системы).

Когда вы заходите на сайт, чтобы посмотреть погоду, вы видите прогноз. На самом деле сайт делает запрос к API сервиса погоды, и тот в ответ присылает данные. А сайт показывает их в красивом и понятном виде.

Зачем нужен API:

  • чтобы одна программа могла использовать данные или функции другой — например, ваш сайт может показывать карты с помощью API от Яндекс Карт;
  • чтобы не давать доступ ко всей системе, а только к нужным частям;
  • чтобы автоматизировать процессы — например, разные боты могут сами публиковать посты через API соцсетей.

У Юздеска тоже есть свой API. Обычно API занимаются разработчики. Для них мы создали документацию, с помощью которой можно работать с Юздеском по API — ознакомиться с ней можно по ссылке.