W niniejszym przewodniku w skrócie wyjaśniono, jak rozpocząć pracę z interfejsem API REST w ConnectedCooking. Należy pamiętać, że niniejszy przewodnik dotyczy wyłącznie naszych rozwiązań w zakresie interfejsu API REST w chmurze.
- Najpierw należy utworzyć klienta API na naszym koncie ConnectedCooking. W tym celu przechodzimy na naszym koncie ConnectedCooking do zakładki „Administracja”.
- Następnie kliknij opcję „Integracje”. Zakładka „API” jest widoczna tylko dla administratorów konta.
- Następnie kliknij „+ Dodaj nowy”
- Na kolejnym ekranie należy podać „ALIAS”, przypisać GRUPĘ i wybrać typ API. W przypadku zapytań API dotyczących HACCP oraz danych na koncie ConnectedCooking należy wybrać typ API „Base API”. Po wypełnieniu wszystkich pól należy kliknąć „Dodaj API”.
- Na kolejnym ekranie otrzymasz dane uwierzytelniające klienta API. Zachowaj je w bezpiecznym miejscu i kliknij przycisk „Zamknij”.
- Po utworzeniu klienta API potrzebujesz narzędzia, aby z niego korzystać. W tym celu możesz użyć programu curl, Postman lub dowolnego innego narzędzia, które znasz. W tym przewodniku korzystamy z Postmana.
- Uruchom aplikację Postman za pomocą ikony aplikacji lub w przeglądarce internetowej. Następnie utwórz nową, pustą kolekcję, klikając symbol „+”, a potem kliknij opcję „Dodaj żądanie”. Alternatywnie możesz po prostu utworzyć nowe żądanie HTTP, klikając opcję „Nowe”.
- Ponadto należy zmienić nowo utworzone żądanie na żądanie typu POST, aby otrzymać token Bearer przy użyciu danych uwierzytelniających klienta API z serwisu ConnectedCooking.
- W związku z tym należy zapoznać się z dokumentacją API Uwierzytelnianie | Centrum pomocy ConnectedCooking
- W dokumentacji wyjaśniono, że w celu uwierzytelnienia kolejnych żądań API należy utworzyć token typu „Bearer”.
- Odbywa się to za pomocą żądania POST. Żądanie POST wykorzystuje następujący punkt końcowy: https://app.connectedcooking.com/api/auth/access
- Ponadto w zakładce „Treść” żądania należy ustawić typ treści „x-www-form-urlencoded”. Następnie należy wprowadzić nazwę użytkownika, hasło oraz zakres uprawnień z klienta API w odpowiednich kolumnach.
- Na koniec kliknij „Wyślij” – powinieneś teraz otrzymać swój „accessToken = BearerToken”
- Aby skorzystać z właśnie utworzonego tokenu BearerToken, potrzebujesz dowolnego interfejsu API, który go obsługuje.
- Wszystkie możliwe żądania API można łatwo sprawdzić w dokumentacji dotyczącej punktów końcowych: Urządzenia końcowe | Centrum pomocy ConnectedCooking
- Na przykład spróbuj skorzystać z punktu końcowego „Lista urządzeń”.
- To żądanie jest bardzo proste – wystarczy użyć adresu „https://app.connectedcooking.com”, dodać do niego „/api/public/devices”, a następnie skopiować i wkleić swój „accessToken” z żądania POST w zakładce „Autoryzacja”, tak jak pokazano na poniższym obrazku. Wystarczy wybrać opcję „Bearer Token” w polu „Auth Type”, a następnie pojawi się pole „Token”.
- Na koniec kliknij również przycisk „Wyślij” – powinieneś otrzymać listę wszystkich urządzeń zarejestrowanych na Twoim koncie ConnectedCooking (lista ta będzie pusta, jeśli na koncie nie masz żadnych urządzeń).
Ten przykład można zasadniczo zastosować do wszystkich punktów końcowych.
Gratulacje! Teraz możesz korzystać z interfejsów API REST w serwisie ConnectedCooking!
Jeśli potrzebujesz dodatkowych informacji, zapoznaj się z naszą dokumentacją API dotyczącą ConnectedCooking: Wprowadzenie | Centrum pomocy ConnectedCooking
