API-ul GetQR este în versiune beta și este disponibil pentru anumite spații de lucru. Detaliile se pot schimba înainte de lansarea generală.
Înainte de a începe
- Sunteți proprietarul spațiului de lucru sau aveți rolul Editor. Utilizatorii cu rolul Viewer nu pot crea și nu pot folosi o cheie API.
- Proprietarul spațiului de lucru are un abonament activ.
Creați cheia API
1
Deschideți setările contului
Deschideți setările contului și accesați API.
2
Generați cheia
Faceți clic pe Generate API key.
3
Copiați cheia
Afișați cheia și copiați-o. Cheile încep cu
sk_live_.Autentificați cererile
Trimiteți cheia ca token Bearer în antetulAuthorization al fiecărei cereri:
Verificarea stării este singurul endpoint care funcționează fără cheie.
Acces și roluri
- Roluri. Doar proprietarul spațiului de lucru și utilizatorii cu rolul Editor pot crea și folosi o cheie API. Utilizatorii cu rolul Viewer nu pot.
- Spațiu de lucru. Fiecare cheie aparține unui singur spațiu de lucru, iar fiecare cerere rulează în acel spațiu de lucru. Nu trebuie să trimiteți un ID de spațiu de lucru.
- Verificări în timp real. Accesul este verificat la fiecare cerere, pe baza rolului dvs. actual și a abonamentului proprietarului spațiului de lucru. Abonamentul dvs. propriu nu contează. Dacă rolul dvs. devine Viewer sau abonamentul proprietarului se încheie, cererile returnează
403până când accesul este restabilit. Nu aveți nevoie de o cheie nouă. - Eliminare. Dacă sunteți eliminat din spațiul de lucru, cheia API este ștearsă. Dacă sunteți adăugat din nou, generați o cheie nouă.
Regenerați cheia
Regenerați cheia dacă a fost divulgată sau dacă a ajuns la cineva care nu ar trebui să o aibă.1
Faceți clic pe Regenerate
În setările contului, accesați API și faceți clic pe Regenerate.
2
Confirmați
Faceți clic pe Regenerate key.
3
Actualizați aplicațiile
Copiați cheia nouă și înlocuiți-o pe cea veche peste tot unde o folosiți.
Păstrați cheia în siguranță
Tratați cheia ca pe o parolă: oricine o are poate crea, modifica și șterge coduri QR în spațiul dvs. de lucru.- Stocați-o într-o variabilă de mediu sau într-un manager de secrete, nu în codul sursă.
- Apelați API-ul doar de pe serverul dvs. Nu puneți niciodată cheia într-un site web, într-o aplicație mobilă sau în orice altceva ce utilizatorii pot inspecta.
- Partajați-o doar cu dezvoltatorii care au nevoie de ea.
- Regenerați-o imediat ce bănuiți că a fost divulgată.
Probleme frecvente
Primesc 401 cu o cheie care funcționa înainte
Primesc 401 cu o cheie care funcționa înainte
Cheia a fost regenerată sau ați fost eliminat din spațiul de lucru, iar cheia a fost ștearsă. Copiați cheia actuală din setările contului sau generați una nouă.
Primesc 403 la fiecare cerere
Primesc 403 la fiecare cerere
Verificați dacă rolul dvs. este proprietar sau Editor și dacă abonamentul proprietarului spațiului de lucru este activ. Cheia funcționează din nou imediat ce accesul este restabilit.
Primesc 404 "This endpoint is not available."
Primesc 404 "This endpoint is not available."
API-ul este în versiune beta și nu este încă activat pentru spațiul dvs. de lucru.
Nu văd setările API
Nu văd setările API
Acestea apar doar pentru proprietarul spațiului de lucru și pentru utilizatorii cu rolul Editor și doar în spațiile de lucru în care API-ul este activat.