For at oprette URL'en til den tjeneste, du ønsker at bruge, skal du følge denne struktur:

Basis-URL, der grupperer webtjenesterne:

hvor du først skal tilføje det segment, der angiver den tjeneste, den henviser til, og derefter de valgfri parametre, der definerer den pågældende forespørgsel. Den første af disse skal indledes med et spørgsmålstegn (?), efterfulgt af et lighedstegn (=) og parameterværdien. Fra den anden parameter, du skal tilføje, skal du bruge ampersand-tegnet (&) i stedet for spørgsmålstegnet.

Eksempel:

Struktur

Konvolutten

Hvert svar er indeholdt i en struktur, der kaldes en »envelope« (konvolut, indpakning). Det betyder, at hvert svar har en foruddefineret struktur, som man kan interagere med.

{
  "Service": "Navn på tjenesten",
  "Version": "Version af tjenesten",
  "TransactionId": "Alfanumerisk transaktions-id",
  "Status": {
    "Code": "Svarskode",
    "Value": "Svarværdi"
  },
  "Data": {}
}

Status

Nøglen status bruges til at indhente oplysninger om tjenestens svar. Hvis alt er forløbet korrekt, vil svaret angive i attributten Kode værdien 200 eller 201. Det kan dog ske, at der opstår en fejl, og i så fald vil svaret se således ud:

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

Autentificering

Når du bruger de webservices, der er tilgængelige på dette websted, skal du være opmærksom på, at adgangsgodkendelsen er grundlæggende og foregår ved hjælp af API-loginoplysninger – brugernavn og adgangskode – som du får via din MasterBase®-konto.

Anvendelsen af disse afhænger af det sprog, der vælges til brug af tjenesterne, og det er den pågældende brugers ansvar.