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ūsena | code | Ką tai reiškia |
|---|---|---|
| 401 | invalid_api_key | Raktas 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. |
| 401 | unauthorized | Nėra Authorization antraštės arba jos bearer žetonas nėra API raktas (API raktai prasideda vc_live_). |
| 403 | api_keys_disabled | Owner ar Admin išjungė API raktus jūsų organizacijoje arba VoiceCap joje išjungė automatizacijas. |
| 403 | email_not_verified | Jūsų el. pašto adresas dar nepatvirtintas. |
| 403 | org_suspended | Jūsų organizacijos veikla sustabdyta. |
| 403 | api_key_not_allowed | Šis galinis taškas API raktų nepriima. Juos priima tik API žinyne išvardyti galiniai taškai. |
| 403 | api_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į.