Il vantaggio principale delle API dell'MasterBase® è che consentono di automatizzare le azioni che vengono eseguite manualmente sulla piattaforma web.
Tra l'altro, lo rendono possibile:
Aggiornate i database nel vostro ambiente di lavoro e contemporaneamente sulla nostra piattaforma.
Create e inviate messaggi dai vostri sistemi senza dover accedere alla nostra piattaforma.
Ricevere dall'MasterBase® i dati metrici della spedizione
MasterBase® API
Imparate dalle nostre API
Per costruire l'URL del servizio che si desidera consumare, è necessario utilizzare la seguente struttura:
URL di base che raggruppa i servizi Web:
https://api2023.masterbase.com
a cui si deve aggiungere prima il segmento che indica il servizio a cui punta e poi i parametri opzionali che definiscono la query in questione. Il primo di questi è preceduto da un punto interrogativo (?), seguito da un segno di uguale (=) e dal valore del parametro. Per il secondo parametro da aggiungere, si deve usare il segno di ampersand (&) al posto del punto interrogativo.
Esempio:
https://api2023.masterbase.com/contatti/v2/nome cliente/?Da=123&Top=100&Ordine=1
Struttura
La busta
Ogni risposta è contenuta in una struttura chiamata busta (busta, wrapper). Ciò significa che ogni risposta ha una struttura predefinita con cui può interagire.
{
"Servizio": "Nome del servizio",
"Version": "Versione del servizio",
"TransactionId": "Identificatore alfanumerico della transazione",
"Stato": {
Code": "Codice della risposta", "Code": "Codice della risposta", "Value": "Valore della risposta",
Value": "Valore della risposta", "Value": "Valore della risposta".
},
"Data": {}
}
Stato
La chiave stato è utilizzato per ottenere informazioni sulla risposta del servizio. Se tutto è proceduto correttamente, la risposta indicherà nell'attributo Code il valore 200 o 201. Tuttavia, può accadere che qualcosa vada storto, nel qual caso la risposta che si otterrà sarà di questo tipo:
"Stato": {
"Code": "401",
"Value": "Unauthorized"
}
Autenticazione
Per l'utilizzo dei servizi web disponibili su questo sito, è necessario considerare che l'autenticazione all'accesso è di base e a tal fine vengono utilizzate le credenziali API -user e password- che si ottengono tramite il proprio account MasterBase®. L'utilizzo di queste dipenderà dalla lingua scelta per il consumo dei servizi ed è responsabilità dell'utente.