Gibt es eine Weboberfläche, mit der ich die API ausprobieren kann?

Mit "GraphiQL" können Sie unsere APIs in Ihrem Browser ausprobieren.

Unterscheidung der URLs

Mit dem Zugriff zu unserer API müssten Sie auch von uns auch mindestens eine URL genannt bekommen haben.

Grundsätzlich gilt:

  • Wenn die URL auf "/api" endet, führt Sie die URL zur GraphiQL-Oberfläche.
  • Wenn die URL auf "/graphql" endet, ist sie der allgemeine Endpunkt, den Sie verwenden, wenn Sie nicht GraphiQL benutzen.
  • Sie können die URLs entsprechend abändern, um entweder zu GraphiQL zu kommen oder den allgemeinen Endpunkt zu nutzen.

Die GraphiQL-Oberfläche

Menüleiste

  • "Play-Button": Query ausführen.
  • Prettify: Den Code (die Query oder mutation) formatieren. Funktioniert nur, wenn der Code fehlerfrei ist.
  • Docs: Die Dokumentation einblenden.

Links oben

Geben Sie hier die Abfrage ein.

Rechts

Hier wird das Ergebnis der zuletzt ausgeführten Abfrage angezeigt.

Links unten

Sie können Variablen für die Query definieren und Request Header mitschicken. Mehr zu den Request Headern unter "Authentifizierung".

Authentifizierung

Sie können die API in der Regel nur verwenden, wenn Sie sich mit einem "Token" authentifizieren.

Token anfordern über cURL

Ergänzen Sie hier  Client ID und Client Secret und fordern Sie ein Token an:

curl --request POST \
--url https://promaterial.eu.auth0.com/oauth/token \
--header 'content-type: application/json' \
--data '{"client_id":"<Your Client ID>","client_secret":"<Your Client Secret>","audience":"http://mdg.promaterial.com/api","grant_type":"client_credentials"}'

Sie erhalten folgende Antwort:

{
"access_token": "<Access token, valid for 24 hours>",
"scope": "read:products read:order read:shoppingCart",
"expires_in": 86400,
"token_type": "Bearer"
}

Token im Request Header mitsenden

Das Token können Sie per JSON direkt über die GraphiQL-Oberfläche mitschicken. Gehen Sie links unten auf den Bereich "REQUEST HEADERS" und fügen Sie das Token in diese Syntax ein:

{ "Authorization": "Bearer <your token>" }

Beispiel:

Tastenkürzel

Folgende Tastenkürzel  können Sie verwenden:

  • STRG + Enter: Query ausführen. Es wird die Query ausgeführt, innerhalb derer sich Ihr Cursor befindet.
  • STRG + SHIFT + P: Query formatieren (Prettify).
  • STRG + LEERTASTE: Auto-Vervollständigung.

Tipps zur Verwendung

  • Benutzen Sie "Docs", das ist die automatische Dokumentation von GraphQL queries. Sie können sich durch alle die Einzelheiten der Queries durchklicken.
  • Verwenden Sie beim Schreiben einer Query in GraphiQL keine Zeilenumbrüche, sondern lediglich Leerzeichen. Die Formatierung können Sie durch den "Prettify"-Befehl erreichen.
  • Mit der Tastenkombination STRG + LEERTASTE fordern Sie Vorschläge von der Autovervollständigung an. Das ist insbesondere nützlich, wenn Sie nicht wissen, welche Möglichkeiten Sie haben.
  • Alternativ können Sie auch anfangen zu tippen und erhalten Vorschläge.
  • Vorschläge können Sie mit den Pfeiltasten anwählen und per TAB bestätigen. So brauchen Sie die Maus nicht.
  • Wenn Sie keine vernünftigen Vorschläge bekommen, können geschweifte oder runde Klammern nötig sein.