Ce guide explique brièvement comment commencer à utiliser l'API REST dans ConnectedCooking. N'oubliez pas que ce guide se réfère uniquement à nos solutions Cloud REST API.
- Tout d'abord, il faut créer un client API dans notre compte ConnectedCooking. Pour cela, nous naviguons dans notre compte ConnectedCooking dans l'onglet Administration.
- Cliquez ensuite sur Intégrations. L'onglet API n'est visible que pour les administrateurs de compte.
- Puis vous cliquez sur "+ Ajouter nouveau"
- Dans l'image suivante, vous indiquez un "ALIAS", attribuez un GROUPE et choisissez un type d'API. Pour les requêtes API concernant l'HACCP et les données de votre compte ConnectedCooking, vous avez besoin du type d'API "Base API". Après avoir rempli toutes les colonnes, vous cliquez sur "Add API".
- Dans l'écran suivant, vous recevez vos identifiants de client API. Veuillez les sauvegarder dans un endroit sûr et cliquez sur Fermer.
- Après avoir créé votre client API, vous avez besoin d'un outil pour l'utiliser. Pour cela, vous pouvez utiliser curl, Postman ou tout autre outil que vous connaissez. Dans ce guide, nous utilisons Postman.
- Démarrez Postman via l'application ou dans un navigateur web. Créez ensuite une nouvelle collection vierge à l'aide du symbole + et cliquez ensuite sur "Ajouter une demande". Vous pouvez également créer une nouvelle requête HTTP en cliquant sur "Nouveau".
- En outre, vous devez modifier votre nouvelle requête créée en une requête POST pour recevoir le Bearer Token à l'aide des informations d'identification de votre client API de ConnectedCooking.
- Vous devez donc consulter la documentation de l'APIAuthentification | ConnectedCooking Help Center
- La documentation explique que vous devez créer un Bearer Token pour authentifier vos demandes d'API ultérieures.
- Ceci est réalisé par une requête POST. La requête POST utilise le point de terminaison :https://app.connectedcooking.com/api/auth/access
- En outre, vous devez définir le Content-Type "x-www-form-urlencoded" dans l'onglet body de votre requête. Ensuite, le nom d'utilisateur, le mot de passe et le champ d'application de votre client API doivent être insérés dans les colonnes disponibles.
- A la fin, vous cliquez sur "Envoyer" et vous devriez maintenant recevoir votre "accessToken = BearerToken".
- Pour utiliser votre BearerToken fraîchement créé, vous avez besoin d'une API pour l'utiliser.
- Vous pouvez facilement vérifier toutes les requêtes API possibles dans la documentation Endpoints :Endpoints | ConnectedCooking - Centre d'aide
- Par exemple, essayez d'utiliser la liste des appareils Endpoint.
- Cette requête est très simple car il suffit d'utiliser "https://app.connectedcooking.com" et d'y ajouter "/api/public/devices" et de copier/coller votre "accessToken" de votre requête POST dans l'onglet Authorization comme dans l'image ci-dessous. Il vous suffit de sélectionner "Bearer Token" dans Auth Type, puis le champ Token apparaîtra.
- À la fin, cliquez également sur "Envoyer" et vous devriez recevoir une liste de tous vos appareils enregistrés dans votre compte ConnectedCooking (cette liste est vide si vous n'avez pas d'appareils dans votre compte).
Cet exemple peut être appliqué à tous les points d'extrémité.
Félicitations, vous pouvez maintenant utiliser les API REST avec ConnectedCooking !
Si vous avez besoin d'informations supplémentaires, veuillez consulter notre documentation API pour ConnectedCooking :Introduction | Centre d'aide ConnectedCooking
