For å lage URL-en til tjenesten du ønsker å bruke, må du følge denne strukturen:

Basis-URL som grupperer webtjenestene:

hvor du først må legge til segmentet som angir tjenesten den peker mot, og deretter de valgfrie parametrene som definerer den aktuelle forespørselen. Den første av disse må innledes med et spørsmålstegn (?), etterfulgt av et likhetstegn (=) og parameterverdien. Fra og med den andre parameteren du trenger å legge til, må du bruke ampersand-tegnet (&) i stedet for spørsmålstegnet.

Eksempel:

Struktur

Konvolutten

Hvert svar er innrammet i en struktur som kalles «envelope» (konvolutt, innpakning). Dette betyr at hvert svar har en forhåndsdefinert struktur som man kan samhandle med.

{
  "Service": "Tjenestenavn",
  "Version": "Tjenesteversjon",
  "TransactionId": "Alfanumerisk transaksjons-ID",
  "Status": {
    "Code": "Svarskode",
    "Value": "Svarverdi"
  },
  "Data": {}
}

Status

Nøkkelen status brukes til å hente informasjon om tjenestens svar. Hvis alt har gått som det skal, vil svaret angi i attributtet Kode verdien 200 eller 201. Det kan imidlertid hende at noe går galt, og i så fall vil svaret se slik ut:

{
  "Status": {
    "Code": "401",
    "Value": "Uautorisert"
  }
}

Autentisering

For å kunne benytte deg av nettjenestene som tilbys på dette nettstedet, må du være oppmerksom på at tilgangsautentiseringen er grunnleggende, og at det derfor benyttes API-påloggingsopplysninger – brukernavn og passord – som du får via din MasterBase®-konto.

Hvilke av disse som skal brukes, avhenger av hvilket språk man velger når man benytter tjenestene, og det er den som benytter tjenestene som har ansvaret for dette.