Per creare l'URL del servizio che desideri utilizzare, devi seguire la seguente struttura:

URL di base che raggruppa i servizi Web:

alla quale devi aggiungere, innanzitutto, il segmento che indica il servizio a cui si riferisce e, successivamente, i parametri opzionali che definiscono la tua query. Il primo di questi deve essere preceduto da un punto interrogativo (?), seguito da un segno di uguale (=) e dal valore del parametro. A partire dal secondo parametro che devi aggiungere, dovrai utilizzare il segno di e commerciale (&) al posto del punto interrogativo.

Esempio:

Struttura

La busta

Ogni risposta è contenuta in una struttura denominata "envelope" (busta, involucro). Ciò significa che ogni risposta ha una struttura predefinita con cui è possibile interagire.

{
  "Service": "Nome del servizio",
  "Version": "Versione del servizio",
  "TransactionId": "Identificatore alfanumerico della transazione",
  "Status": {
    "Code": "Codice della risposta",
    "Value": "Valore della risposta"
  },
  "Data": {}
}

Stato

La chiave stato viene utilizzato per ottenere informazioni sulla risposta del servizio. Se tutto è andato a buon fine, la risposta indicherà nell'attributo Codice il valore 200 o 201. Tuttavia, può capitare che qualcosa vada storto, nel qual caso la risposta che si otterrà sarà di questo tipo:

{
  "Status": {
    "Code": "401",
    "Value": "Non autorizzato"
  }
}

Autenticazione

Per poter utilizzare i servizi web disponibili su questo sito, è necessario tenere presente che l'autenticazione di accesso è di base e che a tal fine vengono utilizzate le credenziali API — nome utente e password — che si ottengono tramite il proprio account MasterBase®.

Il loro utilizzo dipenderà dal linguaggio scelto per l'utilizzo dei servizi ed è di responsabilità di chi effettua tale utilizzo.