Hier wird erläutert, wie Sie mit dem WMS eine REST-API ansprechen und nutzen können. Es wird kurz auf die Grundlagen und Unterschiede von HTTP-Requests und REST eingegangen. Anhand von Beispielen wird gezeigt, wie Sie mit dem WMS externe Schnittstellen ansprechen.

API

API steht für “Application Programming Interface” und beschreibt die Schnittstelle einer Anwendung eines Herstellers. Über die Schnittstelle können Daten abgerufen, geändert und auch gelöscht werden. Die API wird von dem jeweiligen Hersteller definiert und und unterscheidet sich von Anwendung zu Anwendung. Deshalb sollte die API detailliert beschrieben sein, um diese vernünftig nutzen zu können. Es gibt verschiedene Arten von API’s, jedoch wollen wir uns hier auf diejenigen beschränken, welche mit HTTP-Requests angesprochen werden können (z.B. REST-API’s).

HTTP-Request

Ein HTTP-Request (zu deutsch “Anfrage”) wird von einem Client (in unserem Falle das WMS) an einen benannten Host (die Anwendung auf einem Server, welche die API bereitstellt) gesendet.

Um einen HTTP-Request abzusenden wird als Adresse eine URL (Uniform Resource Locator) verwendet, welche alle Informationen enthalten muss, um die API exakt zu adressieren. Wie die Bezeichnung “Uniform Resource Locator” bereits ausdrückt, wird mit der URL eine Resource eine “Quelle” adressiert, von der Daten abgerufen bzw. an die Daten gesendet werden können.

Eine URL besteht normalerweise aus folgenden Komponenten (erklärt an der API von Microsoft Graph):
Beispiel-URL: https://graph.microsoft.com/v1.0/me/joinedTeams?query

• Schema
  Gibt das verwendete Protokoll an, mit dem der Request gesendet wird. Dies ist entweder http oder https.

• Host
  Der Host-Name identifiziert den Host, welcher die API bereitstellt, im Beispiel . Der Host-Name kann eine IP-Adresse und einen Port enthalten.
  Im Beispiel entspricht der Hostname graph.microsoft.com

• Pfad
  Der Pfad gibt die Resource an, welche adressiert werden soll, im Beispiel /v1.0/me/joinedTeams.
  Oftmals gibt es einen Basis-Pfad, welcher bei unterschiedlichen Requests immer gleich bleibt. Im Beispiel wäre dies die Versionsnummer der API /v1.0.

• Query
  Beim Absetzen eines Requests kommt es häufig vor, dass zusätzliche Parameter (z.B. Filter) mitgegeben werden müssen. Die Query besteht aus ein oder mehreren Namen/Werte-Paaren, welche mit einem “&” separiert werden, und wird am Ende des Pfades mit einem “?” angehängt (z.B. ?user=Mustermann&zipcode=83022).

Zusätzlich zu der URL kann der HTTP-Request auch noch eine Liste von Header und einen Content (auch als Body bezeichnet) enthalten.

Die Header werden als Liste von Namen/Werte-Paaren mitgegeben. Welche Header benötigt werden, wird sollte in der API beschrieben sein.

Im Content werden dem HTTP-Request zusätzliche Daten mitgegeben. Diese können in Textform (z.B. im Json-Format) oder FormUrlEncoded übergeben werden. Ein FormUrlEncoded-Content enthält Namen/Werte-Paare, welcher oftmals anstatt der Angabe als Query in der URL bevorzugt wird, weil diese Daten dann nicht in der URL ersichtlich sind.

REST