Den här guiden beskriver kortfattat hur man kommer igång med REST API i ConnectedCooking. Tänk på att den här guiden endast avser våra molnbaserade REST API-lösningar.
- Först måste du skapa en API-klient i vårt ConnectedCooking-konto. För att göra det går vi till fliken ”Administration” i vårt ConnectedCooking-konto.
- Klicka sedan på ”Integrationer”. Fliken ”API” är endast synlig för kontoadministratörer.
- Sedan klickar du på ”+ Lägg till nytt”
- På nästa bild anger du ett ”ALIAS”, tilldelar en GRUPP och väljer en API-typ. För API-förfrågningar som rör HACCP och uppgifterna i ditt ConnectedCooking-konto behöver du API-typen ”Base API”. När du har fyllt i alla kolumner klickar du på ”Lägg till API”.
- På nästa skärm får du dina API-klientuppgifter. Spara dem på en säker plats och klicka sedan på ”Stäng”.
- När du har skapat din API-klient behöver du ett verktyg för att använda den. Till det kan du använda curl, Postman eller något annat verktyg som du känner till. I den här guiden använder vi Postman.
- Starta Postman via appen eller i en webbläsare. Skapa sedan en ny tom samling med hjälp av +-symbolen och klicka därefter på ”Lägg till en begäran”. Alternativt kan du också skapa en ny HTTP-begäran genom att klicka på ”Ny”.
- Dessutom måste du ändra den nyskapade förfrågan till en POST-förfrågan för att kunna hämta Bearer-token med hjälp av dina API-klientuppgifter från ConnectedCooking.
- Därför måste du läsa igenom API-dokumentationen Autentisering | ConnectedCooking-hjälpcenter
- I dokumentationen förklaras att du måste skapa en Bearer-token för att autentisera dina kommande API-förfrågningar.
- Detta sker genom en POST-förfrågan. POST-förfrågan använder följande slutpunkt: https://app.connectedcooking.com/api/auth/access
- Dessutom måste du ange innehållstypen ”x-www-form-urlencoded” på fliken ”Body” i din begäran. Därefter måste användarnamn, lösenord och omfattning från din API-klient fyllas i i de tillgängliga kolumnerna.
- Till slut klickar du på ”Skicka” och bör nu få ditt ”accessToken = BearerToken”
- För att kunna använda ditt nyskapade BearerToken behöver du ett API.
- Du kan enkelt se alla möjliga API-förfrågningar i dokumentationen om Endpoints: Endpunkter | ConnectedCooking-hjälpcenter
- Prova till exempel att använda enhetslistan Endpoint.
- Den här begäran är väldigt enkel, eftersom du bara behöver använda ”https://app.connectedcooking.com”, lägga till ”/api/public/devices” och kopiera och klistra in ditt ”accessToken” från din POST-begäran på fliken ”Authorization”, precis som på bilden nedan. Du behöver bara välja ”Bearer Token” under Auth Type, då kommer fältet Token att visas.
- Klicka sedan på ”Skicka” och du bör få upp en lista över alla dina registrerade enheter i ditt ConnectedCooking-konto (listan är tom om du inte har några enheter i ditt konto).
Detta exempel kan i princip tillämpas på alla slutpunkter.
Grattis, nu kan du använda REST-API:er med ConnectedCooking!
Om du behöver ytterligare information kan du läsa vår API-dokumentation för ConnectedCooking: Inledning | ConnectedCooking-hjälpcenter