Hoppa till innehållet

Autentisera en API-begäran

Skicka en Threetone API-nyckel i begärans header x-api-key och håll autentiseringsuppgiften utanför klientkoden.

Uppdaterad

Skicka API-nyckeln i en header

Det publika programmatiska API:t finns på https://api.threetone.in. Skicka API-nyckeln i begärans header x-api-key:

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

Använd nyckeln som ett headervärde. Lägg den inte i en URL, frågesträng eller begärandekropp. En programmatisk begäran ska skicka x-api-key. Om den skickas tillsammans med en Authorization-header avvisas begäran eftersom autentiseringen blir tvetydig.

Förvara nyckeln på servern

Hämta nyckeln från en hemlighetshanterare eller miljövariabel på serversidan. Bädda inte in den i frontend-JavaScript, mobilappspaket, loggar eller felmeddelanden. Använd en separat nyckel med begränsad behörighet för varje driftsatt integration, så att en läckt autentiseringsuppgift inte ger åtkomst till orelaterade åtgärder.

Spara begärans ID

Threetone returnerar svarshuvudet X-Request-Id. Spara värdet tillsammans med begärans tidsstämpel, metod, sökväg och status när du felsöker. Du kan också skicka ett eget giltigt X-Request-Id; API:t skickar tillbaka det i svaret.

Relaterade artiklar