Dieser Leitfaden erklärt kurz, wie Du mit der REST-API in ConnectedCooking beginnen kannst. Bitte beachte, dass sich dieser Leitfaden nur auf unsere Cloud-REST-API-Lösungen bezieht.
- Zunächst musst Du einen API-Client in Deinem ConnectedCooking-Konto erstellen. Dazu navigiere in Deinem ConnectedCooking-Konto zur Registerkarte „Administration“.
- Klicke anschließend auf „Integrationen“. (Die Registerkarte „API“ ist nur für Account Administratoren sichtbar.)
- Dann klicke auf „+ Neu hinzufügen“.
- Im nächsten Bild gib einen „ALIAS“ ein, weise eine GRUPPE zu und wähle einen API-Typ aus. Für die API-Abfragen zu HACCP und den Daten in Deinem ConnectedCooking-Konto benötigst Du den API-Typ „Base API“. Nachdem Du alle Felder ausgefüllt hast, klicke auf „API hinzufügen“.
- Auf dem nächsten Bildschirm erhälst Du Deine API-Client-Anmeldedaten. Bitte bewahre diese an einem sicheren Ort auf und klicke auf „Schließen“.
- Nachdem Du Deinen API-Client erstellt hast, benötigst Du ein Tool, um ihn zu verwenden. Dazu kannst Du curl, Postman oder jedes andere Dir bekannte Tool verwenden. In dieser Anleitung wird Postman verwendet.
- Bitte starte Postman über die Anwendung oder im Webbrowser. Erstelle dann über das + Symbol eine neue leere Sammlung und klicke anschließend auf „Anfrage hinzufügen”. Alternativ kannst Du auch einfach eine neue HTTP-Anfrage erstellen, indem Du auf „Neu” klickest
- Darüber hinaus musst Du Deine neu erstellte Anfrage zu einer POST-Anfrage bearbeiten, um das Bearer-Token mit Hilfe Deiner API-Client-Anmeldedaten von ConnectedCooking zu erhalten.
- Daher musst Du die API-Dokumentation überprüfen Authentifizierung | ConnectedCooking-Hilfezentrum
- In der Dokumentation wird erklärt, dass man einen Bearer Token erstellen muss, um die weiteren API-Anfragen zu authentifizieren.
- Dies wird durch eine POST-Anfrage erreicht. Die POST-Anfrage verwendet den Endpunkt: https://app.connectedcooking.com/api/auth/access
- Darüber hinaus musst Du den Content-Type „x-www-form-urlencoded“ in der Registerkarte „Body“ Deiner Anfrage festlegen. Anschließend musst Du den Benutzernamen, das Passwort und den Bereich Deines API-Clients in die angezeigten Spalten eingeben.
- Am Ende klickst Du auf „Senden“ und solltest nun Deinen “accessToken = BearerToken” erhalten.
- Um Deinen neu erstellten BearerToken zu verwenden, benötigst Du eine API.
- Du kannst alle möglichen API-Anfragen ganz einfach in der Endpoints-Dokumentation überprüfen.
- Endpoints | ConnectedCooking Help Center
- Versuche beispielsweise, den Endpunkt „Geräteliste“ zu verwenden.
- Diese Anfrage ist sehr einfach, da Du lediglich „https://app.connectedcooking.com“ verwenden und „/api/public/devices“ hinzufügen sowie Deinen „accessToken“ aus Deiner POST-Anfrage in die Registerkarte „Authorization“ kopieren und einfügen musst, wie in der Abbildung unten gezeigt. Du musst lediglich „Bearer Token“ unter „Auth Type“ auswählen, dann erscheint das Feld „Token“.
- Klicke am Ende ebenfalls auf „Senden“ und Du solltest eine Liste aller in Deinem ConnectedCooking-Konto registrierten Geräte erhalten (Diese Liste ist leer, wenn Du keine Geräte in Deinem Konto hast).
Dieses Beispiel lässt sich grundsätzlich auf alle Endpunkte anwenden.
Herzlichen Glückwunsch, Du kannst nun REST-APIs mit ConnectedCooking verwenden!
Wenn Du weitere Informationen benötigst, dann lese bitte unsere API-Dokumentation für ConnectedCooking: Introduction | ConnectedCooking Help Center
