📖 Indice
Cos'è una chiave API?
Una chiave API consente alla tua applicazione di autenticarsi con l'API Yousign.
Identifica la tua organizzazione e consente scambi sicuri di dati, documenti e servizi tramite richieste API.
Ogni chiave API è definita da:
Un ambiente (Sandbox o Produzione)
Un ambito, che determina a quali risorse la chiave può accedere
Un livello di autorizzazione (accesso completo o sola lettura)
Come creare una chiave API
Vai alla sezione Sviluppatori nel menu a sinistra.
Clicca su Chiavi API.
Se è la tua prima chiave API, clicca su Inizia integrazione (ambiente Sandbox).
Altrimenti, clicca su Nuova chiave API nella parte alta della pagina.
Quando crei la tua prima chiave API, il periodo di prova dell'API si avvia automaticamente.
Dovrai compilare le seguenti informazioni:
1. Descrizione
Inserisci un nome per la tua chiave API.
Questo campo è facoltativo, ma consigliato se si prevede di creare più chiavi API. Inserisci una breve descrizione per identificarne lo scopo (ad esempio: "Integrazione CRM - Produzione").
2. Ambiente
Scegli dove verrà utilizzata la chiave API:
Sandbox: ambiente di test per l'integrazione API.
Seleziona questa opzione se stai avviando l'integrazione o non hai ancora un piano API a pagamento.
Produzione: ambiente live per la tua integrazione.
Disponibile solo se hai sottoscritto un piano API.
3. Ambito
Definisci l'ambito della tua chiave API.
L'ambito determina il set massimo di risorse a cui la chiave può accedere.
È possibile scegliere tra:
Ambito dell'organizzazione
La chiave API può accedere alle risorse di tutte le aree di lavoro della tua organizzazione.
Questa opzione consente alla chiave API di accedere a tutti i dati dell'organizzazione.
Adatto per integrazioni globali o a livello di piattaforma.
Ambito dell'area di lavoro
La chiave API può accedere alle risorse solo all'interno di aree di lavoro selezionate.
Durante la creazione è necessario selezionare una o più aree di lavoro.
Le risorse esterne a tali aree di lavoro non sono accessibili.
La chiave non può gestire utenti o aree di lavoro.
L'ambito dell'area di lavoro consente di isolare i dati tra diversi team, progetti o clienti finali.
4. Livello di autorizzazione
Scegli il livello di autorizzazione:
Accesso completo: per creare o aggiornare risorse con richieste API.
Sola lettura: per leggere solo le informazioni trasmesse tramite richieste API.
Una volta compilati tutti i campi, clicca su Crea chiave API.
La tua nuova chiave apparirà nell'elenco delle chiavi API, dove potrai visualizzare:
Ambiente
Livello di autorizzazione
Ambito
Puoi anche utilizzare filtri e opzioni di navigazione nella pagina delle chiavi API per trovare rapidamente chiavi specifiche.
Quante chiavi API posso creare?
Puoi creare fino a 200 chiavi API attive per organizzazione.