Vai al contenuto

API Clienti

Cosa permette di fare

L'API Clienti consente a un sistema esterno di:

  • Consultare l'elenco dei clienti presenti su Areagate, con possibilita' di filtrare per codice o ragione sociale
  • Sincronizzare i clienti modificati dopo un determinato momento
  • Inserire o aggiornare clienti in modo massivo (fino a 500 per chiamata)
  • Gestire i gruppi sconto associati ai clienti

Consultazione clienti

Lista clienti

Permette di ottenere l'elenco dei clienti attivi. E' possibile filtrare per:

  • Codice interno: ricerca esatta per codice cliente
  • Ragione sociale: ricerca parziale (basta una porzione del nome)

I risultati sono impaginati (massimo 500 per pagina).

Clienti aggiornati

Permette di ottenere solo i clienti che sono stati modificati dopo un determinato punto di sincronizzazione. Utile per mantenere allineato un sistema esterno senza dover rileggere tutti i clienti ogni volta.

Questa modalita' restituisce anche i clienti cancellati, in modo che il sistema esterno possa recepire le cancellazioni.

Inserimento e aggiornamento clienti

Il sistema esterno puo' inviare un elenco di clienti da inserire o aggiornare. Per ogni cliente:

  • Se il codice del sistema esterno (codice_host) non esiste su Areagate, il cliente viene creato
  • Se il codice esiste e i dati sono diversi, il cliente viene aggiornato
  • Se il codice esiste e viene indicato come cancellato, il cliente viene disattivato

Dati gestibili

I dati principali che possono essere inviati per ogni cliente:

  • Ragione sociale, indirizzo, localita', provincia, CAP
  • Email, telefono, fax
  • Codice fiscale, partita IVA, nazione
  • Rating, gruppi statistici, fido
  • Riferimenti a: agenzia, pagamento, zona, agente, tipo cliente, gruppo aziende

Raccordi obbligatori

I codici di riferimento (agenzia, pagamento, zona, agente, ecc.) devono corrispondere a raccordi gia' configurati nel sistema. Se un raccordo non viene trovato, l'operazione restituisce un errore.

Migrazione da altri sistemi

Per facilitare la migrazione da sistemi precedenti (BMS/Ocmis), e' possibile indicare un codice host precedente (codice_host_old). Il sistema cerchera' automaticamente il cliente usando i prefissi dei vecchi sistemi e, se trovato, aggiornera' il codice con quello nuovo.

Gruppi sconto

E' possibile gestire l'associazione tra clienti e gruppi sconto:

  • I gruppi sconto non ancora presenti vengono creati automaticamente
  • Le associazioni non piu' presenti vengono disattivate
  • Le associazioni precedentemente disattivate vengono riattivate se inviate nuovamente