Questa documentazione descrive tutti i metodi API per le seguenti azioni:
L'API accetta solo richieste da un elenco limitato di indirizzi IP (ad esempio, dal sito dell'account di un cliente o da un sito di back office).
Qualsiasi richiesta all'API da un indirizzo IP che non è nell'elenco consentito verrà rifiutata.
Questo viene fatto per prevenire attacchi DDoS all'API, tentativi di falsificare richieste ed esperimenti di hacker.
Gli utenti accedono sempre al sito pubblico della piattaforma (ufficio del cliente o back office) e questo sito stesso richiede i dati necessari dall'API della piattaforma. Poiché l'indirizzo IP del sito è fisso, sarà nell'elenco consentito.
Tutte le richieste API vengono effettuate utilizzando i seguenti metodi HTTP:
Ogni sezione dell'API contiene un URL a cui viene inviata una richiesta per ottenere i dati rilevanti.
Il metodo di richiesta HTTP è specificato davanti a ciascun URL.
Ogni richiesta API deve contenere sempre 4 variabili:
Se la richiesta ha esito positivo, l'API restituisce sempre due variabili:
Se la richiesta non riesce, l'API mostra le variabili:
Ogni richiesta API deve contenere una variabile hash che rappresenta la firma digitale della richiesta.
hash = md5($json . $time . $salt)