Questa documentazione descrive tutti i metodi API per le seguenti azioni:

• ottenere elenchi di oggetti (metodo list)
• filtraggio elenco (metodo elenco con dati filtro)
• ottenere informazioni dettagliate su un oggetto (metodo show)
• ottenere i dati per il modulo di aggiunta dell'oggetto (metodo di aggiunta)
• salvataggio dei dati come nuovo oggetto (metodo store)
• ottenere i dati per il modulo di aggiornamento dell'oggetto (metodo di modifica)
• salvataggio dei dati dell'oggetto aggiornato (metodo update)

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:

• GET per elencare, mostrare, aggiungere e modificare
• POST per negozio
• PUT per l'aggiornamento
• DELETE per eliminare

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:

1. data (stringa json con array di dati per API)
2. user (stringa json con una matrice di dati sull'utente corrente)
3. time (ora corrente nel fuso orario UTC)
4. hash (firma digitale sotto forma di hash per verificare che la richiesta all'API provenga sicuramente da una fonte autorizzata)

Se la richiesta ha esito positivo, l'API restituisce sempre due variabili:

1. status = true (stato di successo)
2. data (stringa json con array di dati dall'API)

Se la richiesta non riesce, l'API mostra le variabili:

1. status = false (stato di errore)
2. error (stringa di testo che descrive l'errore)

Ogni richiesta API deve contenere una variabile hash che rappresenta la firma digitale della richiesta.

hash = md5($json . $time . $salt)

• md5, sha256, bcrypt — algoritmi di crittografia disponibili
• $json — json stringa con i dati della richiesta
• $time — ora nel formato "GG.MM.AAAA HH:MM:SS"
• $salt — valore univoco fisso ("sale") per l'API della piattaforma