Naršyti dokumentaciją
Dokumentacija

Autentifikacija

Asmeninis API raktas siunčiamas kaip bearer žetonas. Čia paaiškinta, ką reiškia kiekvienas atmetimas.

Kiekviena užklausa Authorization antraštėje turi asmeninį API raktą. Raktas veikia jį sukūrusio žmogaus vardu, toje organizacijoje, kuri buvo atidaryta kuriant raktą, ir mato lygiai tai, ką tas žmogus gali atidaryti VoiceCap.

Kaip gauti raktą

Sukurkite jį Settings > Profile skiltyje API keys. Žingsniai aprašyti puslapyje API raktai. VoiceCap raktą parodo vieną kartą, kai jį sukuriate. Raktas prasideda vc_live_.

Kaip jį siųsti

curl -H "Authorization: Bearer $VOICECAP_API_KEY" https://voicecap.ai/api/v1/me

API raktą skaito tik iš antraštės. GET /me grąžina žmogų ir organizaciją, kuriems priklauso raktas, todėl tai geras pirmas kvietimas raktui patikrinti ir ryšiui automatizavimo įrankyje pavadinti.

Saugokite raktą kaip slaptažodį. Laikykite jį įrankio slaptų duomenų saugykloje, ne programos kode, ir atšaukite jį Settings > Profile, jei jis galėjo nutekėti.

Kurią organizaciją skaito raktas

Raktas priklauso vienai organizacijai. Jis veikia, kol ta organizacija yra atidaryta VoiceCap. Jei pereinate į kitą organizaciją, raktas atsako 401, kol grįšite atgal. Kitoje organizacijoje sukurti raktai veikia ten.

Kada raktas atmetamas

BūsenacodeKą tai reiškia
401invalid_api_keyRaktas neteisingas, atšauktas (atkūrus ar pakeitus slaptažodį atšaukiami visi raktai), priklauso organizacijai, iš kurios išėjote ar kuri neatidaryta, arba jūsų paskyra išjungta.
401unauthorizedNėra Authorization antraštės arba jos bearer žetonas nėra API raktas (API raktai prasideda vc_live_).
403api_keys_disabledOwner ar Admin išjungė API raktus jūsų organizacijoje arba VoiceCap joje išjungė automatizacijas.
403email_not_verifiedJūsų el. pašto adresas dar nepatvirtintas.
403org_suspendedJūsų organizacijos veikla sustabdyta.
403api_key_not_allowedŠis galinis taškas API raktų nepriima. Juos priima tik API žinyne išvardyti galiniai taškai.
403api_key_requiredŠis galinis taškas priima tik API raktą, ne prisijungimo sesiją. Tai taikoma /hooks galiniams taškams.

403 reiškia, kad pats raktas tinkamas, todėl automatizavimo įrankis neturėtų prašyti jo prijungti iš naujo. Pašalinkite priežastį.

Susiję puslapiai