Questa guida spiega in breve come iniziare a utilizzare le API REST in ConnectedCooking. Tenete presente che questa guida si riferisce solo alle nostre soluzioni Cloud REST API.
- Innanzitutto, è necessario creare un client API nel nostro account ConnectedCooking. Pertanto, nel nostro account ConnectedCooking navighiamo nella scheda Amministrazione.
- Fare quindi clic su Integrazioni. La scheda API è visibile solo agli amministratori dell'account.
- Poi cliccate su "+ Aggiungi nuovo".
- Nell'immagine successiva si fornisce un "ALIAS", si assegna un GRUPPO e si sceglie un tipo di API. Per le query API relative all'HACCP e ai dati del vostro account ConnectedCooking, è necessario il tipo API "Base API". Dopo aver compilato tutte le colonne, si fa clic su "Aggiungi API".
- Nella schermata successiva si ricevono le credenziali del client API. Salvarle in un luogo sicuro e fare clic su Chiudi.
- Dopo aver creato il client API, è necessario uno strumento per utilizzarlo. A tale scopo si può usare curl, Postman o qualsiasi altro strumento conosciuto. In questa guida usiamo Postman.
- Avviare Postman tramite l'applicazione o il browser. Creare quindi una nuova raccolta vuota con il simbolo + e cliccare poi su "Aggiungi una richiesta". In alternativa, è possibile creare una nuova richiesta HTTP cliccando su "Nuova".
- Inoltre, è necessario modificare la nuova richiesta creata in una richiesta POST per ricevere il token del portatore con l'aiuto delle credenziali del client API di ConnectedCooking.
- Pertanto è necessario controllare la documentazione dell'APIAutenticazione | Centro assistenza ConnectedCooking
- La documentazione spiega che è necessario creare un Bearer Token per autenticare le ulteriori richieste API.
- Ciò avviene tramite una richiesta POST. La richiesta POST utilizza l'endpoint:https://app.connectedcooking.com/api/auth/access
- Inoltre, è necessario impostare il Content-Type "x-www-form-urlencoded" nella scheda body della richiesta. Quindi il nome utente, la password e lo scopo del client API devono essere inseriti nelle colonne disponibili.
- Alla fine si clicca su "Invia" e si dovrebbe ricevere "accessToken = BearerToken".
- Per utilizzare il BearerToken appena creato, è necessario utilizzare una qualsiasi API.
- È possibile verificare facilmente tutte le possibili richieste API nella documentazione sugli endpoint:Endpoint | Centro assistenza ConnectedCooking
- Ad esempio, provare a utilizzare l'elenco di dispositivi Endpoint.
- Questa richiesta è molto semplice: basta usare "https://app.connectedcooking.com" e aggiungere "/api/public/devices" e copiare/incollare il proprio "accessToken" dalla richiesta POST nella scheda Autorizzazione, come nell'immagine sottostante. È sufficiente selezionare "Bearer Token" in Auth Type, quindi apparirà il campo Token.
- Alla fine cliccate anche su "Invia" e riceverete un elenco di tutti i dispositivi registrati nel vostro account ConnectedCooking (questo elenco è vuoto se non avete dispositivi nel vostro account).
Questo esempio può essere applicato a tutti gli endpoint.
Congratulazioni, ora siete in grado di utilizzare le API REST con ConnectedCooking!
Per ulteriori informazioni, consultare la documentazione API di ConnectedCooking:Introduzione | Centro assistenza ConnectedCooking