Um die URL des Dienstes zu erstellen, den du nutzen möchtest, musst du folgende Struktur verwenden:

Basis-URL zur Gruppierung der Webdienste:

zu der du zunächst das Segment hinzufügen musst, das den Dienst angibt, auf den sie verweist, und anschließend die optionalen Parameter, die deine jeweilige Abfrage definieren. Der erste Parameter muss mit einem Fragezeichen (?) beginnen, gefolgt von einem Gleichheitszeichen (=) und dem Wert des Parameters. Ab dem zweiten Parameter, den du hinzufügen musst, solltest du das Und-Zeichen (&) anstelle des Fragezeichens verwenden.

Beispiel:

Struktur

Der Umschlag

Jede Antwort ist in einer Struktur namens „Envelope“ (Umschlag, Hülle) enthalten. Das bedeutet, dass jede Antwort eine vordefinierte Struktur aufweist, mit der man interagieren kann.

{
  "Service": "Name des Dienstes",
  "Version": "Version des Dienstes",
  "TransactionId": "Alphanumerische Transaktions-ID",
  "Status": {
    "Code": "Antwortcode",
    "Value": "Antwortwert"
  },
  "Data": {}
}

Status

Der Schlüssel Status wird verwendet, um Informationen über die Antwort des Dienstes zu erhalten. Wenn alles ordnungsgemäß abgelaufen ist, wird in der Antwort im Attribut Code den Wert 200 oder 201. Es kann jedoch vorkommen, dass ein Fehler auftritt; in diesem Fall erhält man eine Antwort wie diese:

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

Authentifizierung

Für die Nutzung der auf dieser Website angebotenen Webservices ist zu beachten, dass die Zugangsauthentifizierung auf einer einfachen Basis erfolgt und hierfür die API-Anmeldedaten – Benutzername und Passwort – verwendet werden, die Sie über Ihr MasterBase®-Konto erhalten.

Die Verwendung dieser Daten hängt von der Sprache ab, die für die Nutzung der Dienste gewählt wurde, und liegt in der Verantwortung des Nutzers.