Documentazione tecnica
Riferimento dell’API, del sistema di eventi, dei webhook e dei protocolli per agenti di XEN, per il team tecnico che integra la piattaforma con i propri sistemi.
Il riferimento si pubblica sezione per sezione, nell’ordine di questo indice.
Ogni sezione esce con i suoi esempi di richiesta e risposta verificati sul server in produzione. Un team che deve integrare oggi riceve il riferimento degli endpoint che usa e una persona di Xeneural per tutta l’integrazione.
Richiedi il riferimento per un’integrazioneOtto sezioni
Autenticazione
Ogni richiesta porta il token di sessione dell’utente nell’intestazione di autorizzazione; il server lo convalida, risale all’utente e rifiuta qualsiasi richiesta senza token prima di toccare un solo dato.
Ambito di organizzazione
L’organizzazione attiva la determina il server a partire dalla sessione; il client non la dichiara mai nella richiesta, quindi un identificatore inviato dall’esterno non può aprire i dati di un’altra azienda.
Endpoint di vendite
Emissione di documenti, bozze e programmazione; verifica dello stato; note di credito e di debito collegate all’originale; serie per punto di emissione.
Endpoint di magazzino
Movimenti di entrata e di uscita, trasferimenti tra magazzini, rettifiche con la loro causale e verifica della giacenza fisica e disponibile per voce e magazzino.
Sistema di eventi
Ogni risultato del server porta un codice di evento piccolo e sequenziale che arriva da un unico registro; i codici si leggono dallo stesso catalogo nell’applicazione, nelle integrazioni e negli agenti.
Webhook
Registrazione di una destinazione per organizzazione, formato dell’invio, firma per verificare l’origine e politica di nuovi tentativi quando la destinazione non risponde.
Protocolli per gli agenti
Come un agente esterno si autorizza con MCP, AP2 e UCP, opera con i permessi dell’utente che lo ha autorizzato e lascia ogni azione nello stesso storico di una persona.
Errori e codici
Forma della risposta di errore, catalogo dei codici per famiglia (convalida, permessi, fiscale, integrazione) e che cosa correggere in ogni caso prima di riprovare.