Перейти до вмісту

Автентифікація запиту API

Надішліть ключ API Threetone в заголовку x-api-key і не розміщуйте його в клієнтському коді.

Оновлено

Надішліть заголовок ключа API

Публічний програмний API працює за адресою https://api.threetone.in. Надсилайте ключ у заголовку запиту x-api-key:

curl --request GET \
  --url 'https://api.threetone.in/v1/convai/agents' \
  --header "x-api-key: $THREETONE_API_KEY"

Використовуйте ключ як значення заголовка. Не кладіть його в URL, рядок запиту чи тіло. Програмний запит має надсилати x-api-key; якщо водночас додати заголовок Authorization, запит відхилять через неоднозначність облікових даних.

Зберігайте ключ на сервері

Завантажуйте ключ із серверного сховища секретів або змінної середовища. Не вставляйте його в JavaScript на клієнті, пакети мобільних застосунків, журнали чи повідомлення про помилки. Для кожної розгорнутої інтеграції використовуйте окремий ключ із вузькими правами, щоб витік одного секрету не відкрив доступ до сторонніх операцій.

Запишіть ідентифікатор запиту

Threetone повертає заголовок відповіді X-Request-Id. Під час усунення проблем зберігайте його значення разом із часом, методом, шляхом і статусом запиту. Також можна надіслати власний коректний X-Request-Id; API повторить його у відповіді.

Пов'язані статті