Doorgaan naar inhoud

Een API-aanvraag authenticeren

Stuur een Threetone-API-sleutel mee in de x-api-key-header en houd de sleutel buiten clientcode.

Bijgewerkt

De API-sleutelheader meesturen

De openbare API voor programmatische toegang is beschikbaar op https://api.threetone.in. Stuur de API-sleutel mee in de aanvraagheader x-api-key:

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

Gebruik de sleutel als headerwaarde. Zet deze niet in een URL, querystring of aanvraagbody. Een programmatische aanvraag moet x-api-key meesturen. Als ook een Authorization-header wordt meegestuurd, wordt de aanvraag wegens dubbelzinnige authenticatie afgewezen.

De sleutel op de server bewaren

Laad de sleutel vanuit een geheimenbeheerder op de server of een omgevingsvariabele. Neem deze niet op in frontend-JavaScript, mobiele appbundels, logboeken of foutmeldingen. Gebruik voor elke uitgerolde integratie een afzonderlijke sleutel met beperkte rechten, zodat een gelekte sleutel geen toegang geeft tot andere activiteiten.

Het aanvraag-ID vastleggen

Threetone retourneert een responsheader X-Request-Id. Bewaar die waarde samen met het tijdstip, de methode, het pad en de status van de aanvraag wanneer je problemen onderzoekt. Je kunt ook zelf een geldige X-Request-Id meesturen. De API geeft deze terug in de respons.

Gerelateerde artikelen