API (Application Programming Interface) — программный интерфейс приложения
API является посредником между разработчиком приложений и какой-либо средой, с которой это приложение должно взаимодействовать. API упрощает создание кода, поскольку предоставляет набор готовых классов, функций или структур для работы с имеющимися данными
Современные API часто принимают форму веб-сервисов, которые предоставляют пользователям (как людям, так и другим веб-сервисам) какую-то информацию. Обычно процедура обмена информацией и формат передачи данных структурированы, чтобы обе стороны знали, как взаимодействовать между собой.
Обычно при обращении к веб API используются запросы HTTP. Существуют стандартные методы, которые могут содержаться в HTTP запросе. Эти методы также называют HTTP глаголами:
- GET. Наверное, самый популярный тип запроса. Используется для получения или чтения данных.
- PUT. Обычно используется для обновления ресурса.
- POST. Обычно используется для создания нового ресурса.
- DELETE. Удаляет данные.
- И другие
Если мы хотим получить информацию о ресурсе, URI которого http://www.example.com/customers/12345, мы можем послать запрос:
GET http://www.example.com/customers/12345
Если мы хотим обновить ресурс — мы можем послать PUT-запрос:
PUT http://www.example.com/customers/12345/orders/98765
Обычные GET запросы способен посылать веб-браузер. Для посылки других типов запросов могут потребоваться скриптовые языки или специальные инструменты
Практикуемся с тестирование API:
Для ознакомления использовался сервис pipedrive.com с открытым интерфейсом API.
Предварительные действия:
- Зарегистрировалась на сайте
- Получила API Token (Меню -> Настройки -> API)
Обычно для использования API нужен специальный ключ, с помощью которого сервер узнает пользователя
- Заходим на сайт Сайт
- В поле “Add your API token” добавляем API Token из личного кабинета
В списке в левой части окна отображается список компонентов и API запросов, с помощью которых можно совершать различные действия над этими компонентами
Например:
Пункт “Deals” в списке соответствует вкладке “Сделки” на сайте
После выбора действия, например “Add a deal”, отобразился список параметров запроса и описание этих параметров.
Т.е чтобы обратиться к методу API, необходимо выполнить, в данном случае, post запрос. Поля ниже — это параметры запроса. Также указывается тип данных, допустимый для каждого пар-ра.
После заполнения полей валидными данными кликаем Test endpoint и видим:
- Информацию о запросе (В формате JSON)
- Информацию об ответе.(В формате JSON)
Сервер может посылать разные коды в ответ на запросы пользователей. Это могут быть коды ошибок или просто коды, информирующие пользователей о состоянии сервера
В данном случае запрос прошел успешно. Об этом говорит запись “success: true”
- Заходим на наш сайт и видим, что в разделе “Сделки” добавилась запись “test!!!” с данными, которые мы указывали, формируя запрос
- Если при формировании запроса мы введем данные невалидного типа (например в поле где должно вводиться число, введем строку), тогда мы получим ответ с сервера:
Мы видим, что запрос не прошел (success: false) и информацию об ошибке
