API (Application Programming Interface, «интерфейс прикладного программирования») — это набор возможностей и правил внутри программы, который позволяет другим программам обращаться к ней и пользоваться её функциями, минуя интерфейс для человека.
С запросом «API» приходят люди с разными задачами. Найдите свою ситуацию.
По определению MDN, API — это простой договор между приложением, которое его предлагает, и другими программами или оборудованием. Он описывает функции и правила обращения, а не устройство программы внутри.
MDN сравнивает API с розеткой: вы не подключаете прибор к проводам напрямую, а вставляете вилку и он работает.
MDN делит API в браузерной разработке на две группы.
| Вид | Что это | Пример по MDN |
|---|---|---|
| Браузерные | встроены в браузер и дают доступ к данным браузера и компьютера | Web Audio API |
| Сторонние | не встроены в браузер, код и данные получают из сети | Google Maps: интерактивная карта на сайте |
Название «веб-API» MDN относит к набору возможностей, который может включать методы, свойства, события и URL-адреса.
Для сайта и аналитики он нужен там, где системам надо обмениваться данными без ручной работы.
| Вопрос | Зачем |
|---|---|
| Есть ли у сервиса программный интерфейс и что он умеет | набор функций определяет поставщик |
| Где документация | по ней разработчик строит интеграцию |
| Как подтверждается доступ | от этого зависит безопасность данных |
| Что будет при недоступности сервиса | чтобы сайт не ломался для посетителей |
| Совпадают ли данные с интерфейсом системы | защита от ошибок в отчётах |
Договор между программами: одна предлагает функции и описывает правила обращения, другая обращается к ним. Человеку удобна кнопка, программе удобен такой договор.
Application Programming Interface, по-русски интерфейс прикладного программирования.
Google Maps API: по MDN, он позволяет показать на сайте интерактивную карту, например, с вашим офисом. Другой пример: Google Analytics Data API для получения отчётов Analytics в своей системе.
Веб-интерфейс даёт человеку кнопки и поля в браузере, а программам даёт функции интерфейс программирования. Разница в том, кто пользуется.
По MDN, это набор возможностей для разработчика, который может включать методы, свойства, события и URL-адреса. Веб-API взаимодействуют с компонентами браузера, другим программным или аппаратным обеспечением и сторонними сервисами.
Документация поставщика и доступ к его сервису. Например, запрос к Google Analytics Data API в документации подтверждается токеном доступа проекта Google Cloud. Для других сервисов смотрите их документацию.
Чтобы автоматически получать данные из систем в один отчёт и не переносить их вручную. Какие данные доступны, определяет документация конкретной системы.
Укажите тематику вашего бизнеса и мы пришлем вам кейсы в ближайшее время