Repository ocmis-api¶

Panoramica¶

Il repository ocmis-api contiene le API pubbliche esposte per l'integrazione con sistemi esterni (portale ordini, servizi applicativi Ocmis). Le note di seguito riguardano lo sviluppo e il test delle API in ambiente locale.

Utilita' generali per sviluppo e test¶

Avvio server in ascolto¶

Dal terminale digitare:

pnpm dev

Verra' restituito un log del tipo:

[17:43:38.134] INFO: Server listening at http://127.0.0.1:3000
[17:43:38.134] INFO: Server listening at http://172.16.10.9:3000
[17:43:38.134] INFO: Server listening at http://10.40.1.16:3000

Da questo log si ricava la porta di esecuzione.

Consultazione documentazione e test¶

La documentazione delle API e la console di test sono raggiungibili all'URL:

127.0.0.1:3000/documentation

E' necessario autenticarsi: il token di autenticazione viene recuperato dal database di riferimento, in funzione del database configurato nel file .env (variabile PGDATABASE):

farmfront_portalcfg

In questo database e' presente la tabella config, dove il token di autenticazione e' registrato alla voce:

cng_chiave = "public_api_orders"

Nota operativa¶

Le API recuperano l'azienda dalla stessa lettura di configurazione: si da' quindi per scontato che sia presente un solo record di configurazione per ciascuna azienda.