Portale per Sviluppatori
Il Portale Sviluppatori Legalesign è il luogo dove puoi gestire l'accesso API e supervisionare la tua organizzazione.
Utilizzalo per creare e revocare le chiavi API, copiare gli identificativi necessari per la tua integrazione, gestire gli endpoint webhook, rivedere le consegne recenti dei webhook e ispezionare l'uso delle API per la tua organizzazione.
Il portale sostituisce il vecchio cruscotto API per i nuovi flussi di lavoro di gestione delle chiavi API. Le chiavi API REST legacy esistenti continuano a funzionare per le integrazioni esistenti, ma le nuove integrazioni dovrebbero usare il portale e il nuovo formato di chiave API.
Accesso
Vai su developer.legalesign.com. Accedi con il tuo account Legalesign. Potresti effettuare il login automaticamente se hai una sessione attiva sull'app web.
Il tuo account deve essere approvato per lo sviluppo API. Se il portale segnala che la gestione delle chiavi API non è abilitata per il tuo utente, crea un ticket di supporto e chiedi che l'accesso API venga verificato.
Chiavi API
La sezione Chiavi API ti permette di creare e revocare chiavi API per un'organizzazione.
Quando crei una chiave, scegli:
- Un nome per la chiave, solitamente l'integrazione o l'ambiente che la utilizzerà.
- L'interfaccia API: REST, GraphQL o entrambe.
- Un periodo di scadenza opzionale.
La chiave API in testo chiaro viene mostrata una sola volta, immediatamente dopo la creazione. Copiala prima di lasciare la pagina perché non potrà essere più mostrata.
Le nuove chiavi usano il formato chiave API enterprise e sono inviate come token bearer:
Authorization: Bearer ak_<environment>_<key-id>.<secret>
Le chiavi REST legacy sono mostrate separatamente quando esistono. Sono supportate solo per integrazioni REST esistenti. Sposta le nuove integrazioni alle nuove chiavi API e revoca le chiavi legacy quando non sono più utilizzate.
Ambiente
La sezione Ambiente mostra gli identificativi dell'organizzazione e del team disponibili per il tuo account.
Usa questa sezione quando una richiesta API necessita di un contesto di organizzazione o team. In particolare, le richieste API REST che agiscono all'interno di un'organizzazione dovrebbero includere l'header dell'organizzazione:
X-Organisation: <organisation-id>
Il portale mostra gli identificativi GraphQL e REST affiancati quando entrambi sono disponibili.
Se il tuo utente API REST è in modalità sandbox, la sezione Ambiente mostra il tuo limite di throttling attuale (100 chiamate all'ora).
Webhook
La sezione Webhook ti permette di creare, modificare, disabilitare e cancellare endpoint webhook.
Per ogni webhook, scegli:
- L'URL dell'endpoint.
- Il tipo di evento.
- L'ambito del gruppo, o tutti i gruppi.
- Se il webhook è abilitato.
Il portale mostra anche i tentativi recenti di consegna dei webhook. Usa la vista log per ispezionare i payload degli eventi, lo stato di consegna e i recenti fallimenti.
Per facilitare lo sviluppo dei webhook, puoi anche inviare manualmente eventi webhook da questa pagina.
Per la configurazione automatizzata, la configurazione dei webhook può essere gestita anche tramite l'API. Consulta la guida ai webhook per dettagli sull'integrazione.
Utilizzo
La sezione Utilizzo riassume l'attività API recente per l'organizzazione selezionata.
Usala per controllare:
- Il volume totale delle richieste.
- Quali chiavi sono state usate.
- Le operazioni principali.
- Il numero di richieste autorizzate e negate.
- L'attività delle richieste nel tempo.
Questo è il primo posto da controllare dopo aver creato una chiave e fatto una richiesta di prova. Aiuta a confermare che la chiave viene usata e se le richieste sono accettate o negate.
Amministratore dell'organizzazione
Gli amministratori dell'organizzazione possono vedere una vista di gestione più ampia per la loro organizzazione.
A seconda dei tuoi permessi, questa sezione può includere:
- Chiavi API a livello di organizzazione.
- Chiavi attive e revocate.
- Uso tra le chiavi dell'organizzazione.
- Eventi di audit delle chiavi API.
- Webhook dell'organizzazione.
Usa questa vista per rivedere gli accessi, revocare chiavi possedute dagli utenti dell'organizzazione e fare audit dei recenti cambiamenti nel ciclo di vita delle chiavi API.
