API Omni Solution

Le API di Omni Solution

Da qui un programma esterno puo' leggere e scrivere i documenti di vendita, le anagrafiche e le tabelle del gestionale. Niente schermate, niente interfaccia: solo chiamate HTTP con un token.

Avvio in 5 minuti
Un token e una prima chiamata che risponde. Da incollare nel terminale.
Concetti
Cliente, azienda, token, licenza: le quattro parole che servono per non sbagliare.
Riferimento completo
Ogni rotta, ogni campo, ogni risposta. Generato dal servizio in esecuzione.
Errori
Cosa significa ogni codice e cosa fare. Compreso quando non ritentare.

Com'e' fatta

Una sola base, https://os1.omnitools.it, e un token JWT nell'intestazione Authorization. Le risposte sono JSON. Non c'e' altro da installare: bastano curl o la libreria HTTP del tuo linguaggio.

CosaDove
Base delle chiamatehttps://os1.omnitools.it
Come si ottiene il tokenPOST /api/auth/login
Come si passa il tokenAuthorization: Bearer <token>
FormatoJSON in entrata e in uscita
Se il servizio rispondeGET /api/health, senza token

Cosa si puo' chiamare

Il riferimento e' diviso in quattro aree. Non e' tutto quello che il sistema sa fare: le rotte di amministrazione e di gestione della piattaforma non sono pubblicate, perche' non servono a chi integra.

AreaA cosa serve
Documenti di venditaBolle, fatture, ordini: leggerli, crearli, modificarli.
AnagraficheClienti, articoli, agenti, causali, codici IVA, listini, vettori.
Tabelle genericheAccesso uniforme a una tabella qualunque, quando non c'e' una rotta dedicata.
AccessoOttenere e rinnovare il token.
Il riferimento non e' scritto a mano.

Viene generato dal servizio in esecuzione: descrive le rotte come sono oggi, non come erano quando qualcuno le ha scritte. Se una rotta cambia, la pagina cambia con lei.