Към съдържанието

Удостоверяване на 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 се отхвърля заради неяснота кое удостоверение да се използва.

Пазете ключа на сървъра

Зареждайте ключа от сървърно хранилище за тайни или променлива на средата. Не го вграждайте във frontend JavaScript, пакети за мобилни приложения, логове или съобщения за грешки. Използвайте отделен ключ с минимални права за всяка внедрена интеграция, така че изтекло удостоверение да не разкрива несвързани операции.

Запишете идентификатора на заявката

Threetone връща заглавка на отговора X-Request-Id. При отстраняване на проблеми запазете стойността ѝ заедно с времето, метода, пътя и статуса на заявката. Можете да изпратите и собствен валиден X-Request-Id; API го повтаря в отговора.

Свързани статии