GetQR API ir beta versijā un pieejams atlasītām darbvietām. Līdz vispārējai izlaišanai detaļas var mainīties.
Pirms sākat
- Jūs esat darbvietas īpašnieks vai redaktors. Skatītāji nevar izveidot vai izmantot API atslēgu.
- Darbvietas īpašniekam ir aktīvs abonements.
API atslēgas izveide
1
Atveriet konta iestatījumus
Atveriet konta iestatījumus un pārejiet uz API.
2
Ģenerējiet atslēgu
Noklikšķiniet uz Generate API key.
3
Nokopējiet atslēgu
Parādiet atslēgu un nokopējiet to. Atslēgas sākas ar
sk_live_.Pieprasījumu autentifikācija
Sūtiet atslēgu kā Bearer marķieri katra pieprasījuma galvenēAuthorization:
Stāvokļa pārbaude ir vienīgais galapunkts, kas darbojas bez atslēgas.
Piekļuve un lomas
- Lomas. Izveidot un izmantot API atslēgu var tikai darbvietas īpašnieks un redaktori. Skatītāji to nevar.
- Darbvieta. Katra atslēga pieder vienai darbvietai, un visi pieprasījumi tiek izpildīti tajā. Darbvietas ID nav jānorāda.
- Pārbaudes reāllaikā. Piekļuve tiek pārbaudīta katrā pieprasījumā pēc jūsu pašreizējās lomas un darbvietas īpašnieka abonementa. Jūsu paša abonements netiek ņemts vērā. Ja jūsu loma mainās uz skatītāju vai īpašnieka abonements beidzas, pieprasījumi atgriež
403, līdz piekļuve tiek atjaunota. Jauna atslēga nav vajadzīga. - Noņemšana. Ja jūs noņem no darbvietas, jūsu API atslēga tiek dzēsta. Ja jūs pievieno atkārtoti, ģenerējiet jaunu atslēgu.
Atslēgas pārģenerēšana
Pārģenerējiet atslēgu, ja tā ir noplūdusi vai tai piekļuvis kāds, kam to nevajadzētu.1
Noklikšķiniet uz Regenerate
Konta iestatījumos pārejiet uz API un noklikšķiniet uz Regenerate.
2
Apstipriniet
Noklikšķiniet uz Regenerate key.
3
Atjauniniet savas lietotnes
Nokopējiet jauno atslēgu un aizstājiet veco visur, kur to izmantojat.
Atslēgas drošība
Izturieties pret atslēgu kā pret paroli: ikviens, kam tā ir, var izveidot, mainīt un dzēst QR kodus jūsu darbvietā.- Glabājiet to vides mainīgajā vai noslēpumu pārvaldniekā, nevis pirmkodā.
- Izsauciet API tikai no sava servera. Nekad neievietojiet atslēgu tīmekļa vietnē, mobilajā lietotnē vai jebkur citur, ko lietotāji var aplūkot.
- Kopīgojiet to tikai ar izstrādātājiem, kuriem tā ir vajadzīga.
- Pārģenerējiet to, tiklīdz rodas aizdomas par noplūdi.
Biežākās problēmas
Saņemu 401 ar atslēgu, kas agrāk darbojās
Saņemu 401 ar atslēgu, kas agrāk darbojās
Atslēga tika pārģenerēta, vai jūs tikāt noņemts no darbvietas un atslēga tika dzēsta. Nokopējiet pašreizējo atslēgu no konta iestatījumiem vai ģenerējiet jaunu.
Saņemu 403 katrā pieprasījumā
Saņemu 403 katrā pieprasījumā
Pārbaudiet, vai jūsu loma ir īpašnieks vai redaktors un vai darbvietas īpašnieka abonements ir aktīvs. Atslēga atkal darbojas, tiklīdz piekļuve tiek atjaunota.
Saņemu 404 "This endpoint is not available."
Saņemu 404 "This endpoint is not available."
API ir beta versijā, un jūsu darbvietai tas vēl nav iespējots.
Neredzu API iestatījumus
Neredzu API iestatījumus
Tie parādās tikai darbvietas īpašniekam un redaktoriem un tikai darbvietās, kurās API ir iespējots.