Portale per Sviluppatori
Il Portale per Sviluppatori di Legalesign è il luogo dove puoi gestire il tuo accesso API e supervisionare la tua organizzazione.
Usalo per creare e revocare chiavi API, copiare gli identificatori necessari per la tua integrazione, gestire gli endpoint webhook, esaminare le consegne recenti dei webhook e ispezionare l’uso dell’API per la tua organizzazione.
Il portale sostituisce il vecchio pannello API per i nuovi flussi di gestione delle chiavi API. Le chiavi legacy REST API esistenti continuano a funzionare per le integrazioni esistenti, ma le nuove integrazioni dovrebbero usare il portale e il nuovo formato delle chiavi 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 indica che la gestione delle chiavi API non è abilitata per il tuo utente, crea un ticket di supporto e richiedi la verifica dell’accesso API.
Chiavi API
La sezione Chiavi API ti consente di creare e revocare le chiavi API per un’organizzazione.
Quando crei una chiave, scegli:
- Un nome per la chiave, di solito l’integrazione o l’ambiente che la utilizzerà.
- L’interfaccia API: REST, GraphQL, o entrambe.
- Un periodo di scadenza opzionale.
La chiave API in chiaro viene mostrata una sola volta, immediatamente dopo la creazione. Copiala prima di lasciare la pagina perché non potrà essere mostrata di nuovo.
Le nuove chiavi utilizzano il formato enterprise delle chiavi API e vengono 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 sulle nuove chiavi API e revoca le chiavi legacy quando non sono più utilizzate.
Ambiente
La sezione Ambiente mostra gli identificatori 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 REST API che agiscono all’interno di un’organizzazione devono includere l’intestazione dell’organizzazione:
X-Organisation: <organisation-id>
Il portale mostra gli identificatori GraphQL e REST affiancati quando entrambi sono disponibili.
Se il tuo utente REST API è in modalità sandbox, la sezione Ambiente mostra anche gli indirizzi email destinatari sandbox approvati. La modalità sandbox limita l’invio di documenti REST a quegli indirizzi.
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, oppure tutti i gruppi.
- Se il webhook è abilitato.
Il portale mostra anche i tentativi recenti di consegna dei webhook. Usa la visualizzazione dei log per esaminare i payload degli eventi, lo stato di consegna e i fallimenti recenti.
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 i dettagli sull’integrazione.
Utilizzo
La sezione Utilizzo riassume l’attività API recente per l’organizzazione selezionata.
Usala per controllare:
- Il volume totale di richieste.
- Quali chiavi sono state utilizzate.
- 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 test. Aiuta a confermare che la chiave viene usata e se le richieste vengono accettate o negate.
Amministratore 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.
- Utilizzo delle chiavi dell’organizzazione.
- Eventi di audit delle chiavi API.
- Webhook dell’organizzazione.
Usa questa vista per rivedere gli accessi, revocare le chiavi possedute dagli utenti dell’organizzazione e verificare i cambiamenti recenti nel ciclo di vita delle chiavi API.
