Autenticazione
Chiavi API dell'account, accesso completo o personalizzato e dove crearne una.
Ogni chiamata a CPI porta una chiave API. Non ci sono un client id separato, né un handshake OAuth, né una firma da calcolare: una sola chiave, inviata con la richiesta.
Creare una chiave
Le chiavi si trovano nella dashboard, nella schermata Sviluppatori del menu dell'account, nella scheda
Chiavi API. Un progetto ha una propria scheda API che crea lo stesso tipo di chiave già limitata a quel
progetto, così non devi mai digitare un app_id a mano. La sandbox del riferimento API
interattivo può anche crearne una al volo, così puoi provare un metodo prima di collegare qualcosa
al tuo codice.
Creare una chiave API richiede la verifica dell'identità, lo stesso controllo di livello 2 che Xuda chiede prima di assegnare un numero di telefono, una casella email o un IP portabile. Un account senza nulla di verificato vede un invito a verificare prima che si apra il modulo della chiave.
Ambito: come quale account agisce la chiave
Una chiave viene creata con uno di tre ambiti e agisce sempre sull'account o sull'app per cui è stata creata:
- Account: agisce direttamente sul tuo account, come faresti da una sessione dashboard autenticata. Raggiunge ogni metodo che una normale chiave account può raggiungere.
- App: creata dalla scheda API di un progetto, legata all'
app_iddi quel progetto. - VPS full stack: emessa automaticamente quando attivi un VPS full stack, limitata ai gruppi di funzionalità scelti alla creazione. Vedi VPS full stack per ciò che copre.
Accesso: completo o personalizzato
Ogni chiave sceglie anche quanto della superficie pubblica può raggiungere:
- Accesso completo: tutto ciò che l'account può fare tramite l'API, compresi i metodi aggiunti dopo la
creazione della chiave. I metodi privati restano esclusi in ogni caso:
private: trueè un muro rigido, controllato a ogni chiamata, non un valore predefinito che l'accesso completo possa scavalcare. - Accesso personalizzato: una lista consentita esplicita che costruisci spuntando i metodi nel modulo della chiave, raggruppati
per microservizio con i campi di ogni metodo mostrati accanto. Un metodo aggiunto in seguito non è incluso
finché non torni a consentirlo. Un metodo la cui
clearanceèpublicè sempre raggiungibile, anche da una chiave personalizzata senza nulla spuntato, perché un metodo pubblico non richiede né sessione né voce nella lista consentita.
I metodi che creano, aggiornano ed elencano le chiavi API (create_account_api_key,
get_app_api_keys e il resto di api_module) non sono mai raggiungibili con una chiave API, per scelta:
una credenziale non può creare né modificare credenziali per l'account con cui si autentica. Gestisci le chiavi dalla
dashboard o da una sessione autenticata.
Inviare la chiave
Con il REST semplice, la chiave è un parametro di richiesta in più, chiamato api_key: un campo nel corpo JSON
con POST, un parametro della query string con GET. Vedi
Chiamare un metodo per entrambe le forme.
Con MCP la stessa chiave va invece in un header Authorization: Bearer, non esiste alcun campo api_key.
Vedi MCP.
Una chiave API è una credenziale al portatore: chi la possiede agisce come il tuo account. Non inserirla mai nel codice lato client, non farne il commit e non incollarla in uno screenshot condiviso. Sostituisci subito una chiave se compare mai in uno di questi posti: la sostituzione mantiene il nome e la modalità di accesso e revoca il vecchio valore nello stesso passaggio.