Logo Icetime

Documentazione API Icetime

Introduzione

Il seguente manuale descrive le funzioni messe a disposizione da Icetime con API Rest integrabili in software di terze parti per eseguire le seguenti operazioni:

END POINT di produzione: https://api.icegiri.it

END POINT di test: https://apitest.icegiri.it

In allegato a questo documento c’è una classe PHP di esempio sull’uso delle funzioni.

Download Esempi PHP

La piattaforma online ha lo scopo di consentire il trasferimento dati che risiederanno sul server in modo “temporaneo”, quindi dopo il download, il client che scarica i dati è tenuto ad eliminarli attraverso le funzioni fornite in queste API.

Non esistono funzioni di update, ogni eventuale modifica ad un articolo, cliente o documento deve essere inviata con la creazione di un nuovo record attraverso il metodo POST.

Occorre quindi tenere presente che quando si scarica un documento, potrebbe essere ripetuto piu’ volte se ha subito diversi aggiornamenti prima di essere scaricato, quindi bisogna prendere l’ultima istanza presente in elenco, essendo che sono ordinati per ID, o comunque fare un controllo di esistenza attraverso Numero*,Data*,Prefisso e Suffisso.

Login

Per usare le funzioni occorre richiamare la funzione /login che riceve nel body l’ApiKey fornita e restituisce il token da passare nell’Authorization delle chiamate REST.

Articoli

Seguire le istruzioni indicate nella guida relativa agli articoli per inviare gli articoli ed eventualmente leggerli successivamente per verifiche o controlli, se necessario.

L’eliminazione di un articolo che è stato già inviato e non ancora scaricato da Icetime, si limita ad eliminarlo dal server. Se si richiama solo la procedura di eliminazione di un articolo, sarà inserito nella coda degli articoli da eliminare, che Icetime scaricherà per tentare l’eliminazione degli stessi (se non sono già movimentati).

Clienti

Seguire le istruzioni indicate nella guida relativa ai clienti per inviare gli articoli ed eventualmente leggerli successivamente per verifiche o controlli, se necessario.

L’eliminazione di un cliente che è stato già inviato e non ancora scaricato da Icetime, si limita ad eliminarlo dal server. Se si richiama solo la procedura di eliminazione di un cliente, sarà inserito nella coda dei clienti da eliminare, che Icetime scaricherà per tentare l’eliminazione degli stessi (se non sono già movimentati).

Documenti

Seguire le istruzioni indicate nella guida relativa ai clienti per inviare gli articoli ed eventualmente leggerli successivamente per verifiche o controlli, se necessario.

I documenti possono essere di tre tipi:

I documenti di tipo ord/dda sono creati dal fornitore ed inviati ad Icetime, che li leggerà e subito dopo li eliminerà del server.

Allo stesso modo i ddt saranno inviati da Icetime verso il fornitore, che li leggerà e dopo sarà tenuto ad eliminarli dal server richiamando la funzione /doc/delete/ddt, che elimina tutti i documenti letti.

Nel momento in cui si esegue la funzione di lettura dei ddt (/doc/read/{tipo} oppure /doc/read/{tipo}/{start}/{limit}) i ddt saranno automaticamente contrassegnati come letti, quindi eliminati non appena si richiama la funzione /doc/delete/ddt

L’eliminazione di un documento che è stato già inviato e non ancora scaricato da Icetime, si limita ad eliminarlo dal server. Se si richiama solo la procedura di eliminazione di un documento, sarà inserito nella coda dei documenti da eliminare, che Icetime scaricherà per tentare l’eliminazione degli stessi (se non sono già movimentati).

Documenti Eliminati

In questa sezione si scarica l’elenco dei documenti (ddt) eliminati da Icetime, questo controllo va fatto per eliminare eventuali ddt generati ed inviati per errore da Icetime. Tali documenti sono identificati con i seguenti campi: