API (Application Programming Interface) — это набор функций, которые позволяют различным программным приложениям взаимодействовать друг с другом. API определяет, как приложения могут запрашивать и получать данные, а также выполнять определенные действия. Он включает в себя:
-
Выполняемые операции (методы) – набор действий или задач, которые приложение может осуществлять через API.
-
Входные данные (запросы) – данные, которые приложение передает в API для выполнения определенной операции. Они могут иметь форму параметров, аргументов или структур данных.
-
Выходные данные (ответы) – это информация, которую API отправляет обратно приложению в ответ на его запрос. Они включают в себя формат и структуру этих данных. Ответы могут содержать запрошенную информацию, подтверждение статуса выполненной операции или детализированные сообщения об ошибках.
API продуктов VSaaS организован на основе REST.
API продукта VMS соответствует следующим принципам REST:
-
Аутентификация: Требует аутентификацию для доступа к ресурсам.
-
JSON: Возвращает данные в стандартном формате JSON.
-
Стандартные коды HTTP: Применяет стандартные коды ответов HTTP для индикации статуса запроса.
Обязательный заголовок
Для обеспечения корректного взаимодействия с API и обработки ответов в ожидаемом формате, абсолютно каждый API-запрос должен содержать HTTP-заголовок заголовок: Content-Type: application/json
Такой заголовок необходим для того, чтобы сервер (backend) понимал, поддерживает ли клиент ответы в формате JSON. Это гарантирует, что сервер будет возвращать все данные, включая сообщения об ошибках, именно в формате JSON.
Отсутствие данного заголовка может привести к тому, что сервер, не имея явного указания на предпочтительный формат, может вернуть ответ в другом формате (например, HTML) даже при возникновении ошибок.