API di Areagate¶
Panoramica¶
Le API di Areagate espongono interfacce REST per l'integrazione con sistemi esterni (gestionali host, e-commerce, applicazioni personalizzate).
Tutte le API seguono le stesse convenzioni:
- Protocollo: REST su HTTPS
- Formato dati: JSON
- Date: epoch in millisecondi (Unix timestamp x 1000)
- Transazionalita': ogni chiamata di scrittura opera in una singola transazione DB; in caso di errore nessun dato viene scritto
- Deduplicazione: i dati gia' presenti vengono riconosciuti tramite chiave esterna (
key_*_host) e non reinseriti
Codici di risposta¶
| Codice | Significato |
|---|---|
| 200 | Operazione completata (il body contiene dettagli su eventuali duplicati) |
| 400 | Errore di validazione del payload |
| 500 | Errore interno (transazione annullata) |
Identificazione anagrafiche¶
Tutte le API che richiedono un'anagrafica accettano due modalita' di identificazione:
| Campo | Descrizione | Priorita' |
|---|---|---|
ana_area |
Codice interno Areagate (tabella ARPANAG) |
Alta |
ana_host |
Codice nel gestionale esterno | Bassa |
Se entrambi sono forniti, ana_area ha priorita'.
API disponibili¶
| API | Endpoint base | Descrizione |
|---|---|---|
| Clienti | /v1/cliente |
Lettura, inserimento e aggiornamento clienti; gestione gruppi sconto |
| Documenti | /v1/documenti |
Inserimento e consultazione documenti |
| Fornitori | /v1/fornitore |
Lettura fornitori (solo consultazione) |
| Giacenze | /v1/giacenze, /v1/giacenze-cap |
Lettura e aggiornamento giacenze per magazzino e capoarea |
| Matricole | /v1/matricola, /v2/matricola |
Lettura, inserimento e aggiornamento matricole (numeri seriali) |
| Merci | /v1/merce |
Lettura, inserimento e aggiornamento merci; gestione raggruppamenti sconti |
| Allegati Merci | /v1/allegato-merce |
Lettura allegati associati a una merce (contenuto in base64) |
| Listini | /v1/listino |
Lettura, inserimento e aggiornamento listini vendita; lettura listini fornitore |
| Merci Fornitori | /v1/merce-fornitore |
Lettura codici articolo fornitore (solo consultazione) |