A GetQR API béta állapotban van, és csak kiválasztott munkaterületek számára érhető el. A részletek az általános kiadásig változhatnak.
Mielőtt elkezdené
- Ön a munkaterület tulajdonosa vagy szerkesztője. A megtekintők nem hozhatnak létre és nem használhatnak API-kulcsot.
- A munkaterület tulajdonosának aktív előfizetése van.
API-kulcs létrehozása
1
Nyissa meg a fiókbeállításokat
Nyissa meg a fiókbeállításokat, és lépjen az API részre.
2
Generálja a kulcsot
Kattintson a Generate API key gombra.
3
Másolja ki a kulcsot
Jelenítse meg a kulcsot, és másolja ki. A kulcsok
sk_live_ előtaggal kezdődnek.Kérések hitelesítése
Minden kérésben küldje el a kulcsot Bearer tokenként azAuthorization fejlécben:
Az állapotellenőrzés az egyetlen végpont, amely kulcs nélkül is működik.
Hozzáférés és szerepkörök
- Szerepkörök. API-kulcsot csak a munkaterület tulajdonosa és a szerkesztők hozhatnak létre és használhatnak. A megtekintők nem.
- Munkaterület. Minden kulcs egyetlen munkaterülethez tartozik, és minden kérés abban a munkaterületben fut. Munkaterület-azonosítót nem kell megadnia.
- Folyamatos ellenőrzés. A rendszer minden kérésnél ellenőrzi a hozzáférést az Ön aktuális szerepköre és a munkaterület tulajdonosának előfizetése alapján. A saját előfizetése nem számít. Ha a szerepköre megtekintőre változik, vagy a tulajdonos előfizetése lejár, a kérések
403választ adnak, amíg a hozzáférés helyre nem áll. Új kulcsra nincs szükség. - Eltávolítás. Ha eltávolítják a munkaterületről, az API-kulcsa törlődik. Ha újra hozzáadják, generáljon új kulcsot.
A kulcs újragenerálása
Generálja újra a kulcsot, ha kiszivárgott, vagy illetéktelen személy fért hozzá.1
Kattintson a Regenerate gombra
A fiókbeállításokban lépjen az API részre, és kattintson a Regenerate gombra.
2
Erősítse meg
Kattintson a Regenerate key gombra.
3
Frissítse az alkalmazásait
Másolja ki az új kulcsot, és cserélje le vele a régit mindenhol, ahol használja.
A kulcs biztonsága
Kezelje a kulcsot úgy, mint egy jelszót: aki birtokolja, QR-kódokat hozhat létre, módosíthat és törölhet a munkaterületén.- Környezeti változóban vagy titokkezelőben tárolja, ne a forráskódban.
- Az API-t csak a saját szerveréről hívja. Soha ne tegye a kulcsot weboldalba, mobilalkalmazásba vagy bármibe, amit a felhasználók megvizsgálhatnak.
- Csak azokkal a fejlesztőkkel ossza meg, akiknek szükségük van rá.
- Generálja újra, amint felmerül a gyanú, hogy kiszivárgott.
Gyakori problémák
401-es hibát kapok egy korábban működő kulccsal
401-es hibát kapok egy korábban működő kulccsal
A kulcsot újragenerálták, vagy eltávolították Önt a munkaterületről, és a kulcs törlődött. Másolja ki az aktuális kulcsot a fiókbeállításokból, vagy generáljon újat.
Minden kérésre 403-as hibát kapok
Minden kérésre 403-as hibát kapok
Ellenőrizze, hogy a szerepköre tulajdonos vagy szerkesztő-e, és hogy a munkaterület tulajdonosának előfizetése aktív-e. A kulcs a hozzáférés helyreállása után azonnal újra működik.
404-es hiba: „This endpoint is not available.”
404-es hiba: „This endpoint is not available.”
Az API béta állapotban van, és a munkaterületén még nincs engedélyezve.
Nem látom az API-beállításokat
Nem látom az API-beállításokat
Csak a munkaterület tulajdonosa és a szerkesztők látják őket, és csak azokban a munkaterületekben, ahol az API engedélyezve van.