Un Chiave API autentica le tue richieste all'API di Simbase. Ogni chiave è associata a una serie di autorizzazioni selezionate al momento della creazione, che rimangono fisse da quel momento in poi. Una singola chiave può essere utilizzata per diverse integrazioni, ma l'impostazione più sicura prevede una chiave per ogni integrazione. Le chiavi vengono create e gestite nella dashboard, alla voce Integrazioni → API.

Crea una chiave API

1. Accedi a dashboard.simbase.com.

2. Vai su Integrazioni → API.

3. Fai clic su "Crea nuova chiave API".

4. Assegna alla chiave un nome che ne indichi la funzione, ad esempio Toolkit Usage Guard. Il nome è solo un'etichetta. Compare solo nell'elenco delle chiavi e in nessun altro posto.

5. Nella sezione “Risorse”, imposta le autorizzazioni necessarie per la chiave. Vedi Autorizzazioni di seguito.

6. Fai clic su "Crea chiave API", quindi copia la chiave.

Guarda la demo qui sotto per le istruzioni passo dopo passo:

Autorizzazioni

Le autorizzazioni vengono impostate per ciascuna risorsa, a uno dei tre livelli disponibili. Nessuno significa che la chiave non può accedere affatto a quella risorsa, ed è l'impostazione predefinita per ogni riga. Leggi recupera i dati senza apportare alcuna modifica. Scrivi crea, aggiorna ed elimina; selezionandola si seleziona automaticamente anche “Lettura” nella stessa riga, poiché qualsiasi operazione di scrittura richiede una lettura preliminare.

Non tutte le risorse offrono tutte e tre le opzioni. "Account" e "Utilizzo" sono in sola lettura, quindi mostrano "Nessuno" e "Lettura". "Stato della scheda SIM", "Reimpostazione", "Registrazione" e "Disattivazione automatica" sono azioni piuttosto che dati, quindi mostrano "Nessuno" e "Scrittura".

L'albero delle risorse

Righe padre e figlio

Le voci "Schede SIM", "Utilità" e "Integrazioni" presentano ciascuna una freccia accanto al nome. Cliccaci sopra per espandere le singole autorizzazioni sottostanti.

• Impostando un elemento padre, tutti gli elementi figlio vengono impostati allo stesso livello o al livello più alto supportato da ciascuno di essi. Impostando tutte le risorse su “Scrittura”, ad “Account” e “Utilizzo” viene assegnato il livello “Lettura”, poiché “Lettura” è il livello massimo da loro supportato.

• Se si imposta un elemento figlio da solo, l'elemento padre non mostra nulla di selezionato. Questo è normale. Un elemento padre visualizza un livello solo quando tutti i suoi elementi figli sono d'accordo.

Scegliere un livello

Garantire il minimo indispensabile per l'integrazione. Una chiave che consente solo la lettura dei dati di utilizzo non può disattivare una SIM in caso di fuga di informazioni.

Nella documentazione di riferimento dell'API questi appaiono come nomi di ambito costruiti a partire dalla stessa struttura ad albero. I dettagli della scheda SIM corrispondono a simcards.details:read e simcards.details:write.

Impostazioni avanzate

Attiva l’opzione “Mostra impostazioni avanzate” per due campi facoltativi. Entrambi possono essere lasciati vuoti.

Restrizioni relative agli indirizzi IP

Limita la chiave a un singolo indirizzo IP attendibile o a un intervallo espresso in notazione CIDR. Le richieste provenienti da qualsiasi altro indirizzo vengono respinte. Lasciare il campo vuoto per non applicare alcuna restrizione. L'elenco delle chiavi mostrerà quindi 0.0.0.0/0 nella sezione "IP consentiti", il che significa qualsiasi indirizzo.

Scade tra (numero di giorni)

Il numero di giorni che intercorrono tra la creazione e il momento in cui la chiave smette di funzionare. Inserisci 31 e la chiave scadrà tra 31 giorni. Se lasci il campo vuoto, la chiave non scadrà mai.

È consigliabile utilizzare le chiavi a durata limitata per migrazioni una tantum, per l'accesso dei collaboratori esterni e per qualsiasi altra situazione in cui altrimenti ci si dovrebbe ricordare di revocarle.

Gestisci le tue chiavi

L'elenco delle API mostra tutte le chiavi presenti sull'account: il nome, un ID chiave troncato, il livello di autorizzazione con cui è stata creata, la data dell'ultimo utilizzo e la restrizione IP. L'ultima chiamata API è riportata nel tuo fuso orario dell'account, e "Indirizzi IP consentiti" indica 0.0.0.0/0 laddove non vi siano restrizioni.

L'ID chiave serve solo a distinguere le chiavi l'una dall'altra. È troncato e non può essere utilizzato per l'autenticazione.

Le autorizzazioni vengono impostate al momento della creazione e non possono essere modificate in seguito. Per modificare le funzionalità di una chiave, crea una nuova chiave con le autorizzazioni desiderate, passa a quella nuova, quindi elimina quella vecchia.

Il menu a tre puntini alla fine di ogni riga presenta un'unica opzione: Elimina. Una chiave eliminata smette immediatamente di funzionare e le richieste che la utilizzano non superano l'autenticazione.

Come utilizzare la chiave

Invia la chiave come token al portatore in ogni richiesta:

Richiesta

GET /v2/simcards HTTP/1.1
Host: api.simbase.com
Authorization: Bearer YOUR_API_KEY

La documentazione completa sugli endpoint è disponibile all'indirizzo developer.simbase.com.

Domande frequenti

Correlati

• Webhook — ricevi gli eventi direttamente su un URL di tua scelta, senza dover interrogare l'API

• Toolkit Usage Guard (fai da te) — un sistema di automazione già pronto che utilizza una chiave API con autorizzazione di scrittura

• Protezione antifurto — il simcards.details:write applicazione pratica

• Fuso orario dell'account — imposta il fuso orario in cui viene visualizzata la colonna “Ultima chiamata API”