Pereiti prie turinio

Autentifikuokite API užklausą

Siųskite API raktą antraštėje, laikykite jį serveryje ir išsaugokite užklausos ID.

Atnaujinta

Siųskite API rakto antraštę

Viešoji programuojama API pasiekiama adresu https://api.threetone.in. Siųskite raktą užklausos antraštėje x-api-key:

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

Raktą naudokite kaip antraštės reikšmę. Nedėkite jo į URL, užklausos parametrus ar turinį. Programinė užklausa turi siųsti x-api-key; siuntimas kartu su Authorization atmetamas kaip dviprasmis.

Laikykite raktą serveryje

Įkelkite jį iš serverio paslapčių tvarkyklės arba aplinkos kintamojo. Neįtraukite į kliento JavaScript, mobiliųjų programų rinkinius, žurnalus ar klaidų pranešimus. Kiekvienai įdiegtai integracijai naudokite atskirą siaurai apribotą raktą, kad nutekėjęs vienas prisijungimo duomuo neatvertų nesusijusių operacijų.

Užrašykite užklausos ID

Threetone grąžina atsakymo antraštę X-Request-Id. Spręsdami problemas išsaugokite ją su užklausos laiku, metodu, keliu ir būsena. Galite siųsti ir savo galiojantį X-Request-Id; API pakartoja jį atsakyme.