Tento průvodce stručně vysvětluje, jak začít s REST API v ConnectedCooking. Mějte prosím na paměti, že se tento průvodce vztahuje pouze na naše cloudová řešení REST API.
- Nejprve je třeba vytvořit API klienta v našem účtu ConnectedCooking. K tomu přejdeme v našem účtu ConnectedCooking na záložku „Správa“.
- Poté klikněte na položku „Integrace“. Karta „API“ je viditelná pouze pro správce účtu.
- Poté klikněte na „+ Přidat nový“
- Na dalším obrázku zadejte „ALIAS“, přiřaďte SKUPINU a vyberte typ API. Pro dotazy API týkající se HACCP a údajů ve vašem účtu ConnectedCooking potřebujete typ API „Base API“. Po vyplnění všech sloupců klikněte na „Přidat API“.
- Na další obrazovce obdržíte své přihlašovací údaje pro API klienta. Uložte si je prosím na bezpečném místě a klikněte na „Zavřít“.
- Po vytvoření API klienta budete potřebovat nástroj, abyste jej mohli používat. K tomu můžete využít curl, Postman nebo jakýkoli jiný nástroj, který znáte. V tomto návodu používáme Postman.
- Spusťte prosím aplikaci Postman buď přímo z aplikace, nebo ve webovém prohlížeči. Poté pomocí symbolu „+“ vytvořte novou prázdnou sbírku a následně klikněte na „Přidat požadavek“. Případně můžete nový HTTP požadavek vytvořit také jednoduše kliknutím na „Nový“.
- Kromě toho musíte nově vytvořený požadavek upravit na požadavek typu POST, abyste mohli získat token typu „Bearer“ s využitím přihlašovacích údajů svého API klienta od ConnectedCooking.
- Proto si musíte prostudovat dokumentaci k API Ověřování | Centrum nápovědy ConnectedCooking
- V dokumentaci je vysvětleno, že pro ověření vašich dalších požadavků na API je nutné vytvořit token typu „Bearer“.
- Toho se dosáhne pomocí požadavku POST. Požadavek POST využívá následující koncový bod: https://app.connectedcooking.com/api/auth/access
- Kromě toho musíte na kartě „Tělo“ svého požadavku nastavit typ obsahu „x-www-form-urlencoded“. Poté je třeba do příslušných sloupců zadat uživatelské jméno, heslo a rozsah oprávnění z vašeho API klienta.
- Na závěr klikněte na „Odeslat“ a nyní byste měli obdržet svůj „accessToken = BearerToken“
- Abyste mohli použít právě vytvořený BearerToken, potřebujete k tomu nějaké API.
- Všechny možné požadavky na API si můžete snadno prohlédnout v dokumentaci k koncovým bodům: Koncové body | Centrum nápovědy ConnectedCooking
- Zkuste například použít koncový bod „Seznam zařízení“.
- Tento požadavek je velmi jednoduchý – stačí použít adresu „https://app.connectedcooking.com“, přidat k ní „/api/public/devices“ a zkopírovat a vložit svůj „accessToken“ z požadavku POST do záložky „Authorization“, jak je znázorněno na obrázku níže. Stačí v poli „Auth Type“ vybrat možnost „Bearer Token“ – poté se zobrazí pole „Token“.
- Na závěr také klikněte na „Odeslat“ a měl by se vám zobrazit seznam všech zařízení, která máte zaregistrovaná ve svém účtu ConnectedCooking (pokud ve svém účtu nemáte žádná zařízení, bude tento seznam prázdný).
Tento příklad lze v zásadě použít na všechny koncové body.
Gratulujeme, nyní můžete využívat REST API v rámci ConnectedCooking!
Pokud potřebujete další informace, podívejte se prosím do naší dokumentace k API pro ConnectedCooking: Úvod | Centrum nápovědy ConnectedCooking
