Введение в API

Добро пожаловать в великий мир API!

В этой статье вы узнаете:* Что такое API* Что такое RESTful API* Как работать с API Tulip.

Что такое API?

API (интерфейс прикладного программирования) - это набор протоколов, которые позволяют различным программным компонентам общаться и передавать данные.

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

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

API-запрос

Запрос API состоит из пяти основных частей:

• Конечная точка: Это специальный URL-адрес, который предоставляет доступ к определенному ресурсу. Например, конечная точка /tables позволяет вам получить все таблицы Tulip или создать новую таблицу Tulip.
• Метод: Это тип операции, которую вы хотите выполнить с помощью API. Поскольку Tulip использует REST API, они ограничены GET, PUT, POST и DELETE.
• Параметры: Переменные, которые передаются в конечную точку API, чтобы предоставить API конкретные инструкции для обработки. Продолжая предыдущие примеры с конечной точкой /tables, вы можете указать конкретный идентификатор таблицы через /tables/{tableId}. Кроме того, у нас есть запросы, которые могут дополнительно изменять параметры.
• Заголовки запросов: Пары ключ-значение, которые предоставляют подробную информацию о запросе, например тип содержимого или учетные данные для аутентификации.
• Тело запроса: Основная часть запроса, в которой подробно описывается, какие данные требуются для создания, обновления или удаления ресурса. Например, в URL-адресе Stations вы можете создать новую станцию и указать, в какую группу станций она должна входить и какие приложения может содержать.

Ответ API

Когда вы успешно составили и отправили REST-запрос, серверы отвечают следующим образом:

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

Общие коды состояния HTTP включают:

200 OK: Указывает, что запрос прошел успешно и тело ответа содержит запрошенный ресурс**.404 Not Found**: Указывает, что сервер не может найти запрашиваемый ресурс, часто из-за неправильного URL-адреса или ресурса, который был перемещен или удален**.400 Bad Request**: Означает, что сервер не может обработать запрос из-за ошибки клиента, например, неправильного синтаксиса или отсутствия необходимых параметров в запросе**.500 Internal Server Error (Внутренняя ошибка сервера**): Указывает на то, что сервер столкнулся с непредвиденными обстоятельствами, которые не позволили ему выполнить запрос, обычно это проблема на стороне сервера, не зависящая от клиента**.302 Found (Moved Temporarily): Указывает на то, что запрашиваемый ресурс был временно перемещен на другой URL. Клиент должен отправить еще один запрос на новый URL, указанный в заголовке ответа.401 Unauthorized**: Означает, что запрос требует аутентификации пользователя, но клиент не предоставил действительные учетные данные или еще не прошел аутентификацию.

Подробнее о кодах ошибок HTTP читайте здесь.

Что такое RESTful API?

Tulip использует RESTful API. Другие типы API включают SOAP, GraphQL, Webbhooks или gRPC.

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

В REST API используются четыре основных метода:1. GET: Этот метод позволяет серверу найти запрошенные вами данные и отправить их вам обратно.2. PUT: Если вы выполните запрос PUT, то сервер обновит запись в базе данных.3. POST: Этот метод позволяет серверу создать новую запись в базе данных.4. DELETE: Этот метод позволяет серверу удалить запись в базе данных.

Как работать с API Tulip

Прочитайте следующие статьи, чтобы начать использовать и тестировать API в Tulip:

• Что такое коннекторы?
• Как создать и настроить функцию HTTP-коннектора
• Настройка API Tulip

Вы нашли то, что искали?

Вы также можете зайти на community.tulip.co, чтобы задать свой вопрос или узнать, сталкивались ли другие с подобным вопросом!