Hopp til innhold

Autentiser en API-forespørsel

Send en Threetone API-nøkkel i x-api-key-headeren, og hold legitimasjonen borte fra klientkoden.

Oppdatert

Send API-nøkkelheaderen

Det offentlige programmatisk tilgjengelige API-et leveres fra https://api.threetone.in. Send API-nøkkelen i forespørselens x-api-key-header:

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

Bruk nøkkelen som en headerverdi. Ikke legg den i en URL, spørringsstreng eller forespørselskropp. En programmatisk forespørsel må sende x-api-key; hvis den sendes sammen med en Authorization-header, blir forespørselen avvist fordi den er tvetydig.

Oppbevar nøkkelen på serveren

Hent nøkkelen fra en hemmelighetsbehandler på serversiden eller en miljøvariabel. Ikke bygg den inn i frontend-JavaScript, mobilapp-pakker, logger eller feilmeldinger. Bruk en egen nøkkel med snevert omfang for hver distribuerte integrasjon, slik at en lekket legitimasjon ikke gir tilgang til uvedkommende operasjoner.

Registrer forespørsels-ID-en

Threetone returnerer svarheaderen X-Request-Id. Ta vare på verdien sammen med tidspunktet, metoden, banen og statusen når du feilsøker. Du kan også sende din egen gyldige X-Request-Id; API-et gjengir den i svaret.

Relaterte artikler