För att skapa URL:en till den tjänst du vill använda måste du följa följande struktur:

Bas-URL som grupperar webbtjänsterna:

till vilken du först måste lägga till det segment som anger vilken tjänst den pekar på, och därefter de valfria parametrarna som definierar just din sökfråga. Den första av dessa måste inledas med ett frågetecken (?), följt av ett likhetstecken (=) och parametervärdet. Från och med den andra parametern som du behöver lägga till ska du använda ampersandet (&) istället för frågetecknet.

Exempel:

Struktur

Kuvertet

Varje svar ingår i en struktur som kallas ”envelope” (kuvert, hölje). Det innebär att varje svar har en fördefinierad struktur som man kan interagera med.

{
  "Service": "Tjänstens namn",
  "Version": "Tjänstens version",
  "TransactionId": "Alfanumeriskt transaktions-ID",
  "Status": {
    "Code": "Svarskod",
    "Value": "Svarets värde"
  },
  "Data": {}
}

Status

Nyckeln status används för att få information om tjänstens svar. Om allt har gått som det ska kommer svaret att ange i attributet Kod värdet 200 eller 201. Det kan dock hända att något går fel, och i så fall kommer svaret att se ut så här:

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

Autentisering

För att kunna använda de webbtjänster som finns tillgängliga på denna webbplats måste du vara medveten om att inloggningen är enkel och att API-inloggningsuppgifterna – användarnamn och lösenord – används för detta, vilka du får via ditt MasterBase®-konto.

Hur dessa används beror på vilket språk som valts för användningen av tjänsterna, och ansvaret ligger hos den som använder tjänsterna.