Что такое API простыми словами?

В статье рассмотрим концепцию работы с API, и как базово поставить задачу на внедрение интеграции с другой системой.

Что такое API?

Сайты взаимодействуют с людьми через браузер. Но помимо людей сайт может взаимодействовать с другими системами - веб-сервисом, 1С, другим сайтом. Чтобы это было возможным, 2 системы (ваш сайт и чужой сервис) должны заранее знать, что и как будет отправляться, по каким правилам - т.е. некий протокол взаимодействия.

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

У сайта может быть свой набор методов API (входящий API), к которому обращается внешний сервис. Либо сам сайт может обращаться к внешнему сервису через специальные запросы.

Инициация таких взаимодействий бывает обычно либо по периоду при определенных условия (например, раз в минуту и при условии, что есть новые заказы), либо инициировано пользователем (создал заказ на сайте и автоматически идет API запрос к 1С для передачи данных заказа).

Что нужно для API?

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

Принимающая запросы сторона должна описать свои методы, чтобы вызывающая сторона знала, что передавать в параметрах запроса, а также как интерпритировать ответы после вызова API.

Обычно для передачи данных используют текстовые форматы JSON или XML - это способы представления информации для легкой программной обработки.

Как проработать API системы?

Если у вас стоит задача внедрить API, то вам нужны 2 вещи:

иметь доступы к возможности обращаться к API (иначе оно будет просто выдавать ошибку "Нет доступа"),
документация с описанием методов API, форматом данных и ограничениями.

Для тестирования методов API удобно использовать программу Postman. Она позволяет подготавливать запросы, отправлять их и получать отклик.

Если у вас есть программист для внедрения API, то помимо "Нам нужна интеграция с 1С" для экономии времени лучше указать связку:

Для каких целей интеграция (что будем передавать, в какую сторону и при каких событиях - по сути список основных методов)
Ссылка на документацию.
Доступы для тестовых запросов.

Заключение

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

В платформе Falcon Space есть свой универсальный модуль API, который позволяет как создавать слой API методов на сайте, так и отправлять https запросы во внешнюю среду.
Документация по API на Falcon Space

Теги: начало проекта (32)