Vai al contenuto principale

Integrazioni e API · Guida

Collega il tuo ERP e altri sistemi

Fai inviare al tuo ERP raccolti e consegne ad A-REX e ricevi eventi in cambio, con i tuoi identificativi, provando prima tutto in un sandbox.

Il tuo ERP conosce già i tuoi raccolti, ricevimenti e spedizioni. Collegarlo significa che nessuno deve digitarli due volte. Tutto si trova in Impostazioni › Integrazioni, in cinque schede: Webhook, In entrata, Client macchina, Indirizzi IP e Identità delle credenziali (l'identità con cui vengono firmati i tuoi passaporti di prodotto, vedi Identità delle credenziali). Proprietari e amministratori configurano i collegamenti delle aziende di produzione; in un sandbox anche gli operatori possono configurarli.

Ciò che arriva da un altro sistema non agisce mai da solo: diventa un evento, una bozza o un'approvazione, e una persona deve approvarlo.

Scegli il modo giusto

Vuoi…Usa
che il tuo ERP invii ad A-REX entrate merci, consegne o risultati di laboratorioIn entrata
che A-REX avvisi il tuo ERP quando un lotto viene registrato, consegnato o certificatoWebhook
che il tuo sistema chiami da solo l'API di A-REXClient macchina
caricare un foglio di calcolo di registrazioniimportazione di file (sotto)

Ricevi messaggi dal tuo ERP

  1. In In entrata, seleziona Aggiungi endpoint in entrata.
  2. Mittente: dagli un nome (per esempio "Entrate merci ERP") e scegli Come firma il mittente.
  3. Accesso e limiti: se vuoi, limita gli Indirizzi mittente consentiti, e imposta dimensione e frequenza dei messaggi.
  4. Messaggio di esempio: incolla un messaggio tipico. I suoi campi diventano il formato atteso.
  5. Seleziona Crea e conferma con un codice della tua app di autenticazione. Copia l'Indirizzo e il segreto nel tuo ERP: il segreto viene mostrato una sola volta.

I messaggi che non corrispondono ai campi attesi vanno In quarantena. Aprine uno per usare Controlla di nuovo dopo aver corretto i campi, oppure Scarta.

Invia eventi al tuo ERP (webhook)

  1. In Webhook, seleziona Aggiungi endpoint.
  2. Destinazione: un nome, l'URL https del tuo sistema e il Formato (CloudEvents (consigliato) o JSON semplice). Spunta Le automazioni possono inviare a questo endpoint se i passaggi delle automazioni devono inviargli messaggi.
  3. Eventi: Parti da un modello (Tutto sui lotti, Solo problemi, Approvazioni, Regole dei lotti e componenti aggiuntivi, Modifiche all’anagrafica, Report), o scegli gli eventi per gruppo. Per esempio, Consegna in attesa e Consegna non riuscita avvisano il tuo ERP quando una consegna approvata resta ferma o non si può fare.
  4. Riepilogo, poi Crea. Copia il segreto di firma. A-REX invia una richiesta di verifica, e l'endpoint diventa Attivo quando il tuo sistema risponde.

Un endpoint riceve gli eventi della propria azienda: eventi reali in un'azienda di produzione, eventi di prova in un sandbox. I messaggi contengono identificativi e link, non nomi. Ogni endpoint elenca le sue Consegne con ogni tentativo; quelle non riuscite vengono ritentate, e Recupera / riproduci i mancanti invia di nuovo ciò che il tuo sistema non ha ricevuto. Consenti nel tuo firewall gli indirizzi elencati in Indirizzi IP.

Controlla che un messaggio venga da A-REX

Ogni messaggio webhook è firmato con il segreto dell'endpoint, che inizia con whsec_. Il tuo sistema deve controllare quella firma prima di fidarsi di un messaggio. Apri l'endpoint in Webhook: il pannello Verifica le firme offre codice pronto in TypeScript, Python, Java e C# che il tuo team IT può copiare. Durante un Ruota il segreto, sia il segreto precedente sia quello nuovo sono validi per il periodo di sovrapposizione che scegli, quindi passali entrambi al controllo.

Client macchina

In Client macchina, seleziona Crea client, scegli il suo Accesso (Lettura, Proposta) e il suo Metodo di accesso: Chiave privata (consigliato) o Segreto del client. Nessun accesso può approvare: ciò che un sistema propone attende una persona. I segreti dei client e le chiavi API dicono a quale tipo di azienda appartengono: iniziano con arex_cs_prod_ o arex_cs_sandbox_, e arex_sk_prod_ o arex_sk_sandbox_, così una chiave di prova non viene mai scambiata per una di produzione. Le chiavi create prima continuano a funzionare.

Descrizioni dell'API e degli eventi

Per il tuo team IT, A-REX descrive la sua API in OpenAPI 3.1 e ogni evento webhook in AsyncAPI 3.0. Entrambe sono generate dalla piattaforma stessa, quindi corrispondono a ciò che accetta e invia. I tuoi sviluppatori possono chiedere i file aggiornati in Assistenza, poi collegarsi con un client macchina.

I tuoi identificativi

Controparti, siti e prodotti possono avere l'identificativo della tua azienda, il codice che hanno nel tuo ERP. La tua integrazione può allora cercare un produttore, un'azienda agricola o un prodotto con il tuo codice, e i messaggi possono includerlo, così il tuo ERP non deve mai imparare gli identificativi di A-REX.

Importazione di file

L'importazione di file (CSV) di entrate di raccolti, consegne, risultati di laboratorio e voci dell'anagrafica è in arrivo in Integrazioni. Controlla prima ogni riga ed elenca gli errori, poi crea approvazioni in attesa, mai modifiche dirette.

Esercitati in un sandbox

Prova tutto prima che lo usi la tua azienda di produzione:

  • Crea un sandbox dalla tua organizzazione: Nuova azienda › Un sandbox. È un'azienda di esercitazione con dati fittizi, e i suoi endpoint ricevono i suoi eventi: approva un raccolto di esercitazione e guarda arrivare il messaggio reale. Gli operatori possono aggiungervi endpoint; in un'azienda di produzione gli endpoint richiedono un proprietario o un amministratore e il suo secondo fattore.
  • Su un endpoint, seleziona Invia un evento di esempio per inviare un esempio firmato, contrassegnato come esempio, e vedere la richiesta e la risposta esatte.
  • La prova di un'automazione simula soltanto i suoi messaggi: nulla raggiunge i tuoi sistemi reali. Vedi Automazioni.