Vai al contenuto principale

Legalesign GraphQL API

Legalesign offre due API per l'integrazione della firma elettronica:

  • REST API – Avvio rapido, formato tradizionale
  • GraphQL API – Piena potenza, più flessibile

Questa guida si concentra su GraphQL. È necessario avere conoscenze di JSON e una base nell’esperienza con richieste web.

Perché scegliere GraphQL?​

REST è affidabile, conosciuto e destinato a rimanere. GraphQL ti offre un modo diverso di pensare all’ottenimento e alla modellazione dei dati. In Legalesign, GraphQL è l’API di prima classe — ogni parte della piattaforma è disponibile tramite essa.

RESTGraphQL
EndpointMultipli (/users, /contracts, ecc.)Singolo (/graphql)
Recupero datiFisso per endpointQuery definite dal client
Over/under-fetchingComuneRidotto
VersionamentoA versioni (/v1/, /v2/)Senza versioni — nuovi campi non interrompono le query esistenti
AutenticazioneChiave APIOAuth 2.0 o chiave API (stesso sottoinsieme supportato)

GraphQL ti dà completo accesso alle funzionalità di Legalesign:

  • Richiedi solo i dati di cui hai bisogno
  • Endpoint unico per tutto
  • Stessa potenza dell’app web

Sviluppatori TypeScript/JavaScript​

Considera il TS/JS SDK per casi d’uso comuni, ma imparare GraphQL ti dà accesso completo alla piattaforma. Confronta SDK e GraphQL.

Prova GraphQL Ora​

Inizia con il GraphQL Explorer (richiede un account attivo).

L’Explorer ti permette di:

  • Testare query e mutation
  • Esplorare lo schema completo
  • Fare debug prima di scrivere codice
informazioni

Se hai effettuato l’accesso a Legalesign, l’autenticazione è automatica.

Per un primo esempio minimo funzionante, vai al Quickstart.

suggerimento

Trova query e mutation pronte ispezionando le richieste di rete nella console dell’app web Legalesign.

Accesso Programmatico​

GraphQL supporta due modalità di autenticazione:

ModalitàCoperturaHeaderIdeale per
OAuth 2.0Solo sottoinsieme supportato (operazioni con chiave API, eccetto generateComponentToken)Authorization: Bearer <access-token>Integrazioni che agiscono per conto di un utente Legalesign, che si autentica e dà consenso
Chiave APISolo sottoinsieme supportatoAuthorization: Bearer <api-key>Automazioni lato server e flussi comuni di invio/lettura

Per OAuth 2.0, registra un client nel Developer Portal e segui la guida per client OAuth.

Per l’autenticazione con chiave API, crea una chiave abilitata per GraphQL nel Developer Portal e controlla le operazioni GraphQL supportate per query e mutation supportate.

Consulta la guida all’autenticazione per maggiori dettagli.

Usi uno strumento di coding AI?​

Se usi Cursor, Claude, Windsurf o un altro assistente AI, collegalo al server della documentazione Legalesign per aiuto contestuale mentre programmi. Vedi Collega il tuo strumento AI.

Prossimi Passi​

  1. Inizia con il Quickstart
  2. Aggiungi eventi in tempo reale con il Real-Time Websocket Quickstart
  3. Esplora lo schema nel GraphQL Explorer
  4. Scegli tra autenticazione OAuth 2.0 o chiave API per accesso programmatico
  5. Segui un tutorial: Node.js · C#
  6. Collega il tuo strumento AI per assistenza al coding contestuale

GraphQL ti dà la stessa potenza dell’app web Legalesign — se puoi farlo lì, puoi farlo con l’API.