Przejdź do treści

Uwierzytelnij żądanie API

Wyślij klucz API Threetone w nagłówku x-api-key i nie umieszczaj danych uwierzytelniających w kodzie klienta.

Zaktualizowano

Wyślij nagłówek klucza API

Publiczne API dostępne programowo działa pod adresem https://api.threetone.in. Wyślij klucz API w nagłówku żądania x-api-key:

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

Użyj klucza jako wartości nagłówka. Nie umieszczaj go w adresie URL, ciągu zapytania ani treści żądania. Żądanie programowe powinno zawierać x-api-key; wysłanie go razem z nagłówkiem Authorization zostanie odrzucone jako niejednoznaczne.

Przechowuj klucz na serwerze

Pobieraj klucz z serwerowego menedżera sekretów lub zmiennej środowiskowej. Nie umieszczaj go w kodzie JavaScript frontendu, pakietach aplikacji mobilnej, dziennikach ani komunikatach o błędach. Dla każdej wdrożonej integracji używaj osobnego klucza o wąskim zakresie, aby wyciek jednego poświadczenia nie ujawnił dostępu do niezwiązanych operacji.

Zapisz identyfikator żądania

Threetone zwraca nagłówek odpowiedzi X-Request-Id. Podczas diagnozowania problemu zachowaj tę wartość wraz z czasem żądania, metodą, ścieżką i statusem. Możesz też wysłać własny, prawidłowy X-Request-Id; API zwróci go w odpowiedzi.

Powiązane artykuły