Ugrás a fő tartalomhoz
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.
A GetQR API minden kérést a fiókja API-kulcsával hitelesít. Minden felhasználónak egy kulcsa van, amely egy munkaterületen az Ön nevében jár el.

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.
A kulcsot bármikor újra megjelenítheti és kimásolhatja. A beállításokban azt is látja, mikor jött létre a kulcs, és mikor használták utoljára.

Kérések hitelesítése

Minden kérésben küldje el a kulcsot Bearer tokenként az Authorization 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 403 vá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á.
A jelenlegi kulcs azonnal megszűnik működni. Minden alkalmazás vagy integráció, amely használja, addig nem működik, amíg az új kulccsal nem frissíti.
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

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.
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.
Az API béta állapotban van, és a munkaterületén még nincs engedélyezve.
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.

Következő lépések

Bevezetés az API-ba

Hibák