Header parameters API – запитів, що слугують для передачі метаданих та керуючої інформації. У REST API заголовки можуть включати різні параметри (див. Understanding REST Headers and Parameters або Заголовки HTTP).
...
| Note |
|---|
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
Типові Headers
Key | Value | Mandatory ( |
|---|
Description(опис призначення або використання Header)
Example(повний приклад ключ:значення)
Key
Value
M/O) | Description | Example | ||
|---|---|---|---|---|
Content-Type | application/json | M | Вказує формат даних у тілі запиту/відповіді | Content-Type: application/json |
Authorization
M
Нетипові Headers:
Authorization | Bearer {{access_token}} | M | Вказує токен авторизації для доступу | Authorization: Bearer Token |
Accept | application/json | O | Вказує, який формат відповіді очікується | Accept: application/json |
User-Agent | {{client_info}} | O | Інформація про клієнтське ПЗ | User-Agent: MyApp/1.0 |
Host | {{host_name}} | M | Ім'я хоста для ідентифікації сервера | Host: api.example.com |
Content-Length | {{content_length}} | O | Довжина тіла запиту в байтах | Content-Length: 348 |
Cache-Control | no-cache | O | Вказує правила кешування | Cache-Control: no-cache |
Accept-Encoding | gzip, deflate | O | Способи стиснення, які підтримуються | Accept-Encoding: gzip, deflate |
Connection | keep-alive | O | Визначає тип з'єднання | Connection: keep-alive |
Key: Назва заголовка.
Value: Значення, яке потрібно використовувати.
Mandatory (M/O): Позначка обов'язковості заголовка — M (Mandatory, обов’язковий) або O (Optional, необов’язковий)
...
.
Description
...
Example(повний приклад ключ:значення)
...
Content-Type
...
application/json
...
Content-Type:application/json
...
: Короткий опис призначення заголовка.
Example: Повний приклад заголовка із значенням.
Не-типові Headers (виключення по проєктам)
Key | Value | Mandatory (M/O) | Description | Example |
|---|---|---|---|---|
X-Custom-PSK | {{pre_shared_key}} | M | Попередньо узгоджений ключ для аутентифікації | X-Custom-PSK: abc123secure |
JWT | {{jwt_token}} | M | JSON Web Token для аутентифікації | JWT: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... |
...
JWT: Заголовок для передачі JSON Web Token, який використовується для аутентифікації та забезпечення безпеки при взаємодії з API.
X-Custom-PSK: Раніше доданий заголовок для використання з попередньо узгодженим ключем.
Обидва заголовки є важливими для аутентифікації в окремих проєктах, забезпечуючи різні рівні безпеки та взаємодії з сервером.