API: различия между версиями

Материал из Поле цифровой дидактики
(Добавила видео про API на русском)
Строка 11: Строка 11:


{{#widget:YouTube|id=s7wmiS2mSXY|start=5}}
{{#widget:YouTube|id=s7wmiS2mSXY|start=5}}
{{#widget:YouTube|id=vPVAYsc-U60|start=1}}





Версия 03:36, 20 декабря 2023


Описание Интерфейс прикладного программирования application programming interface (API) - — описание способов взаимодействия одной компьютерной программы с другими. API (интерфейс прикладного программирования) упрощает процесс программирования при создании приложений, абстрагируя базовую реализацию и предоставляя только объекты или действия, необходимые разработчику. Если графический интерфейс для почтового клиента может предоставить пользователю кнопку, которая выполнит все шаги для выборки и выделения новых писем, то API для ввода/вывода файлов может дать разработчику функцию, которая копирует файл из одного места в другое, не требуя от разработчика понимания операций файловой системы.
Область знаний NetSci, Информатика
Авторы
Поясняющее видео https://www.youtube.com/watch?v=WXsD0ZgxjRw
Близкие понятия APIs for social scientists: A collaborative review
Среды и средства для освоения понятия Python, Snap!, MQTT, App Inventor

Интерфейс прикладного программирования (API) — это абстракция (очень) высокого уровня, обеспечивающая стандартный способ взаимодействия с ПО или инфраструктурой. Совсем упрощенно можно определить API как ПО, предоставляющее стандартизированный интерфейс, с помощью которого другое ПО может выполнить желаемое действие.

API-интерфейсы, абстракции очень высокого уровня, обеспечивающие стандартный способ взаимодействия с ПО или инфраструктурой, широко распространены в информатике. API предоставляют системную точку входа или библиотечную функцию с четко определенным синтаксисом, доступным из прикладных программ или пользовательского кода для предоставления четко определенного функционала. API играют важную роль в облачных системах и могут иметь различные формы (например, API POSIX).


Примером API, построенного на основе REST, является NASA Earth API, позволяющий исследовать доступные наборы данных, в том числе изображения.

Nasa rest api.jpg


Рецепты с API

 Description
Как дополнить датасет из MediaWiki API в мобильном приложенииУ нас есть датасет, в котором есть названия городов, дополнительная информация (страна и численность жителей). Мы хотим представить эту информацию и дополнить её дополнительными сведениями из MediaWiki. При этом будем использовать MediaWiki API
  • 120px-List_Picker_Wikipedia.png
Как использовать Scratch APIКак использовать внешний API в средах визуального программирования
Как использовать Web API with App InventorОбщие советы о том, как использовать внешний API и во что превращаются данные из JSON
Как использовать песочницу MediaWiki APIСовременные MediaWiki площадки поддерживают не только собственный API, но и инструмент для формирования запросов к нему. В этой статье рассказываются приёмы формирования таких запросов. Обратите внимание, что правила общие для всех площадок - Служебная:ApiSandbox
Как обратиться к API из Snap!Невозможно обратиться напрямую к большинству открытых API из Snap! Но, можно организовать такое обращение и обработку данных из JSON формата
Как представить JSON из API в виде диаграммы PlantUMLМы получаем наборы данных из внешнего API и прежде чем что-то с ними делать хотим посмотреть на их структуру. Для этого использует редактор PlantUML - https://plantuml.com/json
Как собрать данные API запроса в DictionaryПолучили данные запроса к mediawiki api и хотим считать их в Dictionary, чтобы иметь возможность обращаться по ключам.

Перечни доступных API

Word API

https://random-word-api.vercel.app/api?words=5
https://snap.berkeley.edu/project?username=unsullied123%2drblx&projectname=api%20request%20demo

Cat facts API

https://catfact.ninja/fact
https://snap.berkeley.edu/project?username=mdwalters124&projectname=Random%20Cat%20Facts%20%28API%20powered%29

Какие преимущества дает API

Использование API выгодно и разработчикам, и бизнесу. Это позволяет:

- Ускорить выпуск новых приложений. Для стандартных задач выгодно использовать готовые решения, а не придумывать все с нуля.

- Защитить разработку. API позволяет скрыть отдельные функции программы и сделать их доступными только через интерфейс.

- Упростить и стандартизировать способ взаимодействия между приложениями, расширить возможности интеграции между сервисами.

- Сократить бюджет на разработку за счет использования готовых решений.

- Получить дополнительную прибыль. Создатели сложных программных продуктов через API предоставляют платный доступ к функциям другим разработчикам.

- Автоматизировать взаимодействие между программами. Больше не нужно вручную перекладывать данные из банка в учетную систему. У банка есть API, и учетная система сходит и сама заберет нужные данные без участия человека.

Как работает Application Programming Interface

Принцип работы Application Programming Interface очень прост. Программа-клиент формирует запрос к API — выполнить операцию. Интерфейс получает данные и перенаправляет запрос программе-поставщику, которая реализует функцию. А затем возвращает результат клиенту. Если операцию не удалось выполнить или запрос некорректный, API формирует сообщение об ошибке.

How api works.png

Виды API по доступу

Существуют API с локальным и удаленным доступом.

API с удаленным доступом работают через интернет. В этом случае говорят о взаимодействии клиента, программы выполняющей запрос, и сервера, программы посылающей ответ. Чтобы вызвать метод, клиент формирует URL и «переходит» по ссылке, то есть отправляет запрос серверу.

При локальном доступе необходимо установить приложение, которое реализует функции API. Код поставщика при этом может быть скрыт или защищен. Вам не нужно вникать и разбираться, как он устроен.