Wie kann ich die API mit Insomnia ausprobieren?

Insomnia ist ein REST Client; wir zeigen Ihnen, wie Sie Insomnia verwenden können, um unsere API zu testen.

Insomnia installieren

Laden Sie Insomnia für Ihr Betriebssystem herunter und installieren Sie es:

https://insomnia.rest/download

Arbeitsumgebung benennen (optional)

Klicken Sie auf den Pfeil rechts neben "My Workspace" und wählen Sie "Workspace Settings"

Geben Sie einen Namen ein, zum Beispiel "ProMaterial API", dann schließen Sie das Fenster mit dem Kreuz wieder.

Request anlegen, um Token anzufordern

Das DistributionGate verlangt ein Token, hierfür legen wir den ersten Request an.

Wir nennen, den Request "Token" und bestätigen mit "Create".

Ein leerer Request wird angelegt.

URL

Neben GET die URL eintragen:

https://promaterial.eu.auth0.com/oauth/token

Body

 JSON einfügen:

{
"client_id": "",
"client_secret": "",
"audience": "http://mdg.promaterial.com/api",
"grant_type": "client_credentials"
}

Bei client_id und client_secret die Informationen eintragen, die wir Ihnen zur Verfügung gestellt haben.

Header

Im Tab "Header" wird automatisch ein Eintrag ergänzt.

Request absenden

Über "Send" den Request absenden.

Erfolg

Wenn alles geklappt hat, kommt der Status-Code 200 und eine JSON als antwort zurück. Die JSON enthält das "access_token".

Mögliche Fehler

Wenn client_id oder client_secret falsch sind, kommt der Status-Code 401 zurück.

Wenn Sie eine falsche URL oder den falschen Request-Typ (GET statt POST) verwenden, kommt der Status-Code 404 zurück.

productsearch Query

Neue Query erstellen, POST auswählen und dann GraphQL.

URL

http://demo.dg.prod.promaterial.com/graphql

Body

Eine sehr einfache Query. Mehr zur productsearch.

query q1 {
productsearch(query: "") {
content {
productDetails {
descriptions {
descriptionShort
}
}
}
}
}

Header

Der Header "Content-Type=application/json" wird automatisch von Insomnia angelegt.

Der Header "Authorization" muss hinzugefügt werden. Der Wert ist "Bearer " und das Token aus der Antwort des vorherigen Requests.

Senden

Der Request kann jetzt abgesendet werden und sollte einen Status-Code 200 und Produktergebnisse als JSON zurückgeben.

Schema aktualisieren

Damit die Autovervollständigung und Syntaxkontrolle funktionieren, muss dass Schema vom Server geladen werden.

Die zwei Requests verbinden

Bis jetzt haben wir das Token manuell vom ersten Request in den Header des zweiten Requests kopiert. Das Token hat jedoch nur eine Gültigkeit von 86400 Sekunden = 1 Tag. Wir können den zweiten Request so anpassen, dass der erste Request automatisch ausgeführt und das Token in den zweiten übernommen wird.

Das Token entfernen, "Bearer " einschließlich Leerzeichen stehen lassen. Dann STRG + Leertaste drücken, ein Menü öffnet sich. "response" tippen und "Response -> Body Attribute" wählen.

Auf das rote Kästchen klicken.

Dann Einstellungen wie auf dem Bild gezeigt wählen.

Im Filter eingeben:

$.access_token

 

Bestätigen.

Der zweite Request kann jetzt ausgeführt werden. Wenn das Token aus dem ersten Request abgelaufen ist, wird da Token automatisch erneuert.