Zum Hauptinhalt springen

GraphQL

Meister1 verwendet eine GraphQL API. GraphQL ist eine Abfragesprache, die dem Client erlaubt, selbst zu bestimmen, welche Daten er benötigt.

Hier wollen wir kurz zeigen, wie eine HTTP-Anfrage in GraphQL aussieht. Ausserdem werden wir einige typische Fallbeispiele betrachten.

Endpoint: https://api.meister1.com/graphql

vorsicht

Für die Abfragen muss ein Authorization Header mit dem accessToken verwendet werden (Siehe Autorisierung)

Allgemein​

Grundsätzlich sieht jede Anfrage gleich aus. Es ist ein POST Request. Im Body wird das Schema definiert, das man als Antwort erwartet.

Request​

query {
  viewer {
    id
    email
  }
}

cURL​

curl 'https://api.meister1.com/graphql' -H 'Content-Type: application/json' \
 --data-binary '{"query":"query {\n  viewer {\n    id\n    email\n  }\n}"}' --compressed

Response​

{
  "data": {
    "viewer": {
      "id": "VSFlcgox",
      "email": "user@meister1.de"
    }
  }
}

Query Builder​

Wechseln Sie oben zwischen Lesen (Queries) und Schreiben (Mutations). Wählen Sie eine oder mehrere Queries bzw. Mutations aus – sie werden zusammengeführt und die GraphQL-Operation wird live erzeugt. Für Mutations werden zusätzlich die möglichen Werte (z. B. der Lead-Status) angezeigt.

Verfügbare Queries
Ausgewählte Queries

Noch keine Queries ausgewählt – nur die Basis-Query wird angezeigt.

GraphQL Query
query {
  viewer {
    id
    email
  }
}