Vai al contenuto principale
L’API di GetQR è in beta ed è disponibile per alcuni workspace selezionati. I dettagli possono cambiare prima del rilascio generale.
L’API di GetQR autentica ogni richiesta con la chiave API del tuo account. Ogni utente ha una sola chiave, che agisce a tuo nome in un workspace.

​
Prima di iniziare

  • Sei il proprietario del workspace o un Editor. I Viewer non possono creare né usare una chiave API.
  • Il proprietario del workspace ha un abbonamento attivo.

​
Crea la tua chiave API

1

Apri le impostazioni dell'account

Apri le impostazioni dell’account e vai su API.
2

Genera la chiave

Fai clic su Generate API key.
3

Copia la chiave

Mostra la chiave e copiala. Le chiavi iniziano con sk_live_.
Puoi mostrare e copiare di nuovo la chiave in qualsiasi momento. Le impostazioni indicano anche quando è stata creata la chiave e quando è stata usata l’ultima volta.

​
Autentica le richieste

Invia la chiave come token Bearer nell’header Authorization di ogni richiesta:
Il controllo dello stato è l’unico endpoint che funziona senza chiave.

​
Accesso e ruoli

  • Ruoli. Solo il proprietario del workspace e gli Editor possono creare e usare una chiave API. I Viewer no.
  • Workspace. Ogni chiave appartiene a un solo workspace e tutte le richieste vengono eseguite in quel workspace. Non devi indicare l’ID del workspace.
  • Controlli in tempo reale. A ogni richiesta l’accesso viene verificato in base al tuo ruolo attuale e all’abbonamento del proprietario del workspace. Il tuo abbonamento personale non conta. Se il tuo ruolo diventa Viewer o l’abbonamento del proprietario termina, le richieste restituiscono 403 finché l’accesso non viene ripristinato. Non ti serve una nuova chiave.
  • Rimozione. Se vieni rimosso dal workspace, la tua chiave API viene eliminata. Se vieni aggiunto di nuovo, genera una nuova chiave.

​
Rigenera la chiave

Rigenera la chiave se è trapelata o se qualcuno che non dovrebbe averla vi ha accesso.
La chiave attuale smette subito di funzionare. Le app o le integrazioni che la usano non funzionano più finché non le aggiorni con la nuova chiave.
1

Fai clic su Regenerate

Nelle impostazioni dell’account, vai su API e fai clic su Regenerate.
2

Conferma

Fai clic su Regenerate key.
3

Aggiorna le tue app

Copia la nuova chiave e sostituisci quella vecchia ovunque la usi.

​
Proteggi la chiave

Tratta la chiave come una password: chiunque la possieda può creare, modificare ed eliminare QR code nel tuo workspace.
  • Conservala in una variabile d’ambiente o in un gestore di segreti, non nel codice sorgente.
  • Chiama l’API solo dal tuo server. Non inserire mai la chiave in un sito web, in un’app mobile o in qualsiasi altro elemento che gli utenti possono ispezionare.
  • Condividila solo con gli sviluppatori che ne hanno bisogno.
  • Rigenerala appena sospetti che sia trapelata.

​
Problemi comuni

La chiave è stata rigenerata, oppure sei stato rimosso dal workspace e la chiave è stata eliminata. Copia la chiave attuale dalle impostazioni dell’account o generane una nuova.
Verifica che il tuo ruolo sia proprietario o Editor e che l’abbonamento del proprietario del workspace sia attivo. La chiave torna a funzionare appena l’accesso viene ripristinato.
L’API è in beta e non è ancora abilitata per il tuo workspace.
Sono visibili solo al proprietario del workspace e agli Editor, e solo nei workspace in cui l’API è abilitata.

​
Passaggi successivi

Introduzione all'API

Errori