Как работает API: запрос, ответ, ключ, эндпоинт

Основные элементы API

### 1. Запрос

Запрос — это то, что вы отправляете в API.

Например:

### 2. Ответ

Ответ — это то, что API возвращает на ваш запрос.

Это может быть:

### 3. API-ключ

API-ключ — это пароль или токен, который подтверждает доступ к API.

Он нужен для:

### 4. Endpoint

Endpoint — конкретный адрес API, куда отправляется запрос.

Например:

Каждый endpoint отвечает за свою задачу.

• получить список товаров
• создать заявку
• отправить сообщение
• проверить статус оплаты
• данные в формате JSON
• сообщение об ошибке
• подтверждение успеха
• список объектов
• авторизации
• защиты данных
• ограничения доступа
• `/users`
• `/orders`
• `/send-message`
• `/chat/completions`

Как это работает на примере

Допустим, вам нужно получить список клиентов из CRM.

Что происходит:

1. Ваш сервис отправляет запрос на endpoint

2. В запросе передаётся API-ключ

3. CRM проверяет ключ

4. CRM возвращает список клиентов

5. Ваш сайт или бот показывает эти данные пользователю

HTTP-методы

Чаще всего API работает через HTTP-методы:

Для новичка достаточно запомнить: GET = получить, POST = отправить.

• **GET** — получить данные
• **POST** — создать или отправить данные
• **PUT** — обновить данные
• **PATCH** — частично изменить данные
• **DELETE** — удалить данные

Формат данных

Чаще всего API возвращает данные в формате **JSON**.

{ "success": true, "message": "Заявка успешно создана" }

Коды ответа

Полезно знать базовые HTTP-коды:

• **200** — запрос выполнен успешно
• **400** — ошибка в запросе (неверные параметры)
• **401** — неверный или отсутствующий ключ
• **402 / 429** — проблемы с балансом или лимитами
• **500** — ошибка на стороне сервера

Итог

Любой API — это цепочка: endpoint + ключ + запрос → ответ. Если что-то не работает, проверяйте по порядку: адрес, ключ, формат запроса, баланс или права доступа.