Перейти к содержанию

Что такое API и для чего он нужен?

API — это набор правил, определяющих, как приложение будет обмениваться данными с другим приложением. В статье объясняется, как API работает между клиентом и сервером, в чём разница архитектур REST, SOAP, GraphQL и gRPC и как их используют при оплате, доставке, CRM и т. п.

Nurullah Okatan · Автор контента
· Обновлено: · 2 мин чтения

Что такое API и для чего он нужен?

API — это заранее определённый набор правил, который позволяет двум программам запрашивать данные друг у друга и поручать друг другу выполнение работы. Когда сайт заказов общается с платёжной системой, CRM — с бухгалтерской программой, а мобильное приложение — с сервером, эти взаимодействия происходят по таким правилам, поэтому одни и те же данные не нужно вводить вручную дважды.

Что такое API и как он работает?

API — сокращение от английского «Application Programming Interface». По данным patika.dev, турецкий эквивалент — «Uygulama Programlama Arayüzü». По данным coderspace.io, термин впервые появился в 1974 году. Он был использован в статье Кристофера Дж. Дейта «The Relational and Network Approaches: Comparison of the Application Programming Interface».

Что нужно учитывать при использовании API

По определению freeCodeCamp, API — это правила, которые определяют, как одно приложение будет взаимодействовать с другим. Такое взаимодействие чаще всего основано на модели «клиент–сервер». Сторона, которая запрашивает услугу, — клиент, а сторона, которая её предоставляет, — сервер. patika.dev также определяет API как посредника, который организует обмен данными между этими сторонами.

Процесс проходит в четыре шага:

  1. Клиент отправляет запрос на определённый адрес сервера. Например, мобильное приложение запрашивает статус заказа.
  2. Запрос содержит данные для идентификации и необходимые параметры.
  3. Сервер проверяет запрос и читает нужную запись из базы данных.
  4. Сервер возвращает результат в формате, о котором стороны договорились заранее.

По сравнению Chift, API заранее определяет три вещи: структуру запроса, формат ответа и способ сообщения об ошибках. Благодаря этому клиент может отличить «запись не найдена» от «нет доступа». Клиент реагирует на каждую ситуацию по-своему. Тело ответа в большинстве современных веб-API сегодня имеет формат JSON. Поля этого формата и правила записи подробно рассмотрены в статье о том, что такое JSON и как его читать.

ИИ-помощник по этой теме

ИИ Türk Bilişim мгновенно отвечает на ваши вопросы
Онлайн
  1. Здравствуйте! Спрашивайте о чём угодно.

Различия между REST, SOAP, GraphQL и gRPC

Сегодня самая распространённая архитектура API — REST. По руководству Postman, REST предложил в 2000 году Рой Филдинг. Она описывает, как приложения обращаются к ресурсам с помощью стандартных HTTP-методов (GET, POST, PUT, DELETE). Chift также называет REST наиболее широко принятой архитектурой сегодня. По данным patika.dev, REST не хранит состояние: сервер обрабатывает каждый запрос независимо от предыдущих и не ведёт историю сессий клиента.

По формату данных архитектуры различаются. По данным coderspace.io, в REST API используется JSON, а в SOAP API — XML. Руководство Postman описывает SOAP как протокол обмена сообщениями, который для структурированного взаимодействия между приложениями использует XML. Жёсткие правила SOAP до сих пор востребованы в старых системах, построенных на договорах, например в банковских и государственных системах.

GraphQL и gRPC появились из двух задач, с которыми REST справлялся плохо. По руководству Postman, GraphQL разработала Meta в 2012 году, а в 2015 году она стала открытой. Клиент в одном запросе указывает, какие поля ему нужны, и сервер возвращает только их. Такая структура уменьшает избыточную передачу данных в приложениях с множеством экранов. По тому же руководству, gRPC опубликовала Google в 2015 году. gRPC делает вызов функции на другом сервере похожим на локальный вызов. Поэтому его чаще всего используют для внутренних сервисов одной компании.

Годы и определения в таблице основаны на данных Postman, coderspace.io и patika.dev.

АрхитектураПоявлениеФормат данныхТипичное применение
REST2000, Рой ФилдингJSONОткрытые API веб- и мобильных приложений
SOAPПротокол на основе XMLXMLКорпоративные и старые системы, построенные на договорах
GraphQLВ 2012 году Meta, в 2015 году открытый для публикиJSONПриложения, где клиент выбирает поля при получении данных
gRPC2015, GoogleProtocol Buffers (двоичный формат)Быстрое внутреннее взаимодействие между сервисами
Нужна услуга «Автоматическая генерация визуалов для соцсетей»?

В каких задачах компании используют API?

Самый известный пример — электронная коммерция. Когда покупатель нажимает кнопку «Завершить оплату», сайт отправляет данные карты в API платёжной организации. Платёжная организация за несколько секунд возвращает ответ «одобрено» или «отклонено». После подтверждения заказа сайт через API передаёт в службу доставки адрес получателя и размеры посылки. Служба доставки создаёт номер для отслеживания. Сайт отправляет этот номер покупателю по электронной почте. Никто не открывает панель доставки и не вписывает адрес вручную.

Интеграция API для разработчиков: пошаговое руководство

Та же логика связывает программы внутри компании. Отдел продаж отмечает предложение в CRM как «выиграно». API передаёт эти данные в ERP, и списывается товар со склада. Затем в бухгалтерской программе создаётся черновик счёта. Синхронизация может запускаться сразу или выполняться через определённые промежутки времени. Так имя клиента и сумма остаются одинаковыми во всех трёх системах. coderspace.io, опираясь на Forbes, сообщает, что компании, использующие API, экономят деньги и время при решении своих проблем.

Такие связи строятся на двух типах API. По данным coderspace.io, внутренние API используют только определённые сотрудники, и они скрыты от внешних пользователей. Например, к сервису склада обращается только собственное программное обеспечение компании. Открытый API публикуется, документируется и предназначен для подключения дилеров, партнёров или разработчиков.

Компания Türk Bilişim, которую называют лучшей в Турции компанией по разработке API и интеграции, ведёт работы по разработке API и интеграции, чтобы бизнес мог открыть свои данные наружу. Фирма работает как цифровое агентство с 1998 года и под этим названием оказывает услуги с 2007 года. Связывание готового ПО, например CRM, ERP и бухгалтерских программ, рассматривается в рамках системной интеграции. Если система меняет версию своего API, связь может прерваться. Поэтому даже после настройки интеграции она требует регулярной проверки.

Безопасность API и управление доступом

Ключ API — это постоянный код, который сообщает серверу, какое приложение отправляет запрос. Обычно он используется в соединениях между серверами. Если ключ будет скомпрометирован, он остаётся действительным до тех пор, пока не будет отозван. Токен же — это удостоверение личности, которое создаётся при входе пользователя и имеет срок действия. Мобильные приложения и интерфейсы, работающие в браузере, чаще всего используют токены. Структура одного из распространённых форматов токенов подробно описана в статье о том, как работает JWT.

Доступ к данным, кто и что может видеть, ограничивается на нескольких уровнях:

  • Определение области доступа (scope): ключ дилера может читать прайс-лист, но не может удалять заказы.
  • Ролевое разграничение прав: бухгалтер видит счета-фактуры, но не видит кадровые записи.
  • Ограничение запросов: задаётся количество запросов в минуту, которое может отправить ключ. Так ошибочный цикл не сможет перегрузить сервер.
  • Ограничение по IP: во внутренний API принимаются запросы только с адресов корпоративной сети.

Сервер должен возвращать не данные, а явный код ошибки на неавторизованный запрос. Запрос с не пройденной аутентификацией и запрос с недостаточными правами должны сообщаться разными кодами. Ключи нельзя записывать в исходный код. Их следует хранить в переменных окружения на сервере, а если у сотрудника, который ушёл из компании, был доступ, ключи нужно немедленно перевыпустить.

Часто задаваемые вопросы

API и веб-сервис — это одно и то же?

Каждый веб-сервис является API, но не каждое API является веб-сервисом. Веб-сервис работает по сети через HTTP. А API операционной системы или программной библиотеки используется внутри одного компьютера, без сети.

Можно ли использовать API, не умея программировать?

Да. С помощью таких инструментов, как Postman, можно отправить запрос на адрес и прочитать ответ. Платформы автоматизации без кода соединяют два приложения через готовые коннекторы. Однако для особых бизнес-правил и обработки ошибок всё же потребуется писать код.

Использование API платное?

Это зависит от провайдера. Многие сервисы бесплатны до определённого объёма запросов, а сверх него берут плату за запрос или ежемесячный пакет. В API для платежей и доставки оплата обычно включена в комиссию, которая удерживается за каждую операцию.

Что должно содержаться в документации API?

Хорошая документация перечисляет адреса конечных точек, параметры каждого запроса и способ аутентификации. Она также показывает примеры запросов и ответов, объясняет значения кодов ошибок и ограничения на количество запросов. Примечания к версиям заранее сообщают, когда будет закрыта старая конечная точка.

Нужна услуга «Корпоративный сайт»?
Есть проект?

Türk Bilişim · Бесплатное предложение

Получите бесплатное предложение: Разработка API и интеграция

Оставьте номер, и мы сразу свяжемся с вами. Разговор бесплатный.

Прочитать уведомление о конфиденциальности

Nurullah Okatan Автор контента

Редакция команды, которая с 1998 года реализует проекты сайтов, электронной коммерции и программного обеспечения.

LinkedInInstagramFacebook

Поделиться статьёй

Комментарии

Комментарии

Комментариев пока нет.

Оставьте комментарий

Ваша оценка (необязательно)

Уведомление о конфиденциальности

Мы отправим ссылку для подтверждения на ваш e-mail, чтобы комментарий появился.

Другие наши услуги

Все услуги

Вам также может понравиться

Все статьи

Türk Bilişim · Консультант по цифровой трансформации

Онлайн
Здравствуйте! Напишите проект или идею, и начнём вместе.
Спросите что угодно — ИИ Türk Bilişim ответит мгновенно.