La documentazione per sviluppatori (/developers)

La pagina Documentazione della API pubblica raccoglie in un unico posto tutto quello che serve a chi sviluppa un'integrazione con Accordyx: endpoint, parametri, schemi delle risposte e codici di errore, sempre allineati alla versione della API in servizio. Puoi passarne il link al tuo fornitore IT o al tuo sviluppatore.

Come arrivarci

• Dall'app: Impostazioni → API & Integrazioni, link Documentazione interattiva della API nel riquadro in cima alla pagina.
• Direttamente all'indirizzo app.accordyx.it/developers: la pagina è pubblica e non serve un account per leggerla.

Cosa trovi nella pagina

In alto c'è un riquadro con i dati per iniziare:

• URL base — l'indirizzo a cui inviare le richieste (lo stesso «Endpoint base» mostrato nelle Impostazioni);
• Autenticazione — l'header Authorization: Bearer ak_live_…;
• Chiave API — dove si crea: "Si crea dall'app in Impostazioni → API & Integrazioni: ogni chiave ha i propri permessi (scope) e un limite di 60 richieste al minuto.";
• il link alla specifica della API in formato JSON, da importare negli strumenti di sviluppo.

Sotto trovi il riferimento interattivo, diviso in sezioni: Controparti, Contratti e documenti, Scadenze, Export CSV e Webhook. Ogni sezione si apre con una frase che spiega a cosa serve; ogni operazione mostra lo scope richiesto, i parametri, gli esempi di risposta e i possibili errori.

In che lingua

La pagina e la documentazione sono in italiano o in inglese, secondo la lingua che hai scelto nell'app o, se non l'hai mai scelta, quella del tuo browser.

Provare le chiamate dalla pagina

Puoi eseguire le chiamate direttamente dalla pagina:

1. Premi Authorize e incolla una chiave API.
2. Apri un'operazione, premi Try it out, compila i parametri e premi Execute.

Come avvisa la pagina, "Le richieste di prova partono dal tuo browser con la chiave che inserisci in «Authorize»: usa una chiave con i soli permessi che ti servono. La chiave resta solo in questa pagina e si perde quando la chiudi."

Le chiamate di prova agiscono sui dati reali della tua organizzazione: una richiesta di scrittura crea o modifica davvero controparti e contratti e consuma le quote del piano. Per provare in sicurezza usa una chiave con i soli scope di lettura e revocala quando hai finito: vedi Le chiavi API.

Problemi comuni

• Le chiamate di prova rispondono 401 — non hai inserito la chiave in Authorize, oppure la chiave è stata revocata.
• Le chiamate rispondono 403 "Scope mancante: …" — la chiave non ha lo scope dell'operazione che stai provando.
• Ho chiuso la pagina e devo reinserire la chiave — è voluto: la chiave non viene salvata.
• Per tutti gli altri codici vedi Errori e limiti dell'API.