La fonctionnalité API Externe de la Plateforme IOK permet d’intégrer vos équipements, menus, recettes et données opérationnelles avec des systèmes externes, ERP, tableaux de bord, applications propres, plateformes BI et autres solutions développées par votre entreprise.

Avec elle, il est possible d’automatiser les processus, de consommer les données de la plateforme en temps réel et même de connecter directement les équipements via API, selon les besoins de l’opération.

Pré-requis

Avant d’utiliser les fonctionnalités de l’API, il est nécessaire de :

1. Posséder un compte actif sur la Plateforme IOK
2. Être lié à une entreprise sur la plateforme
3. Avoir accès aux équipements et menus que vous souhaitez utiliser

Si vous n’avez pas encore accès :

• Découvrez comment créer un compte :
  Plateforme IOK - Onglet Connexion
• Découvrez comment inviter des utilisateurs dans une entreprise existante :
  Plateforme IOK - Onglet Utilisateurs

Recommandation importante

Pour profiter au mieux des fonctionnalités de l’API, nous recommandons que votre compte dispose déjà de :

• Équipements enregistrés
• Menus créés
• Groupes et recettes configurés

Articles liés :

• Équipements :
  Plateforme IOK - Onglet Équipements
• Menus :
  Plateforme IOK - Onglet Mes Menus

Remarque :
Il est également possible de connecter les équipements directement à la Plateforme IOK en utilisant l’API elle-même.

Comment activer le mode Développeur et générer le Token

Après vous être connecté à la Plateforme IOK :

1. Cliquez sur votre nom d’utilisateur en haut à droite
2. Sélectionnez l’option « Modifier le compte »
3. Cliquez sur « Token Développeur »

Une fenêtre s’affichera vous demandant le mot de passe actuel de la plateforme.

4. Saisissez votre mot de passe
5. Cliquez sur « Confirmer »

Après confirmation, le mode Développeur sera activé et un Token Développeur sera généré.

Important :
Ce token est utilisé pour authentifier les requêtes effectuées via l’API. Nous recommandons de le garder en sécurité et de ne pas le partager avec des tiers.

Copier le Token Développeur

Après génération :

1. Copiez le token affiché à l’écran
2. Utilisez ce token pour l’authentification des requêtes API

Ce token doit être envoyé dans les en-têtes des appels aux endpoints de la plateforme.

Accéder à la documentation de l’API

Après avoir activé le mode Développeur, une nouvelle option appelée « API Externe » apparaîtra dans le menu latéral de la Plateforme IOK.

En accédant à cette option, vous serez redirigé vers la documentation interactive de l’API.

Sur cette page, il est possible de :

• Visualiser tous les endpoints disponibles
• Comprendre les paramètres de chaque requête
• Consulter des exemples de payloads
• Tester les requêtes directement depuis le navigateur
• Valider les intégrations avant la mise en œuvre finale

Comment authentifier les requêtes

Dans la documentation de l’API :

1. Cliquez sur le bouton « Authorize »
2. Insérez le Token Développeur
3. Confirmez l’authentification

Après cela, les requêtes effectuées dans la documentation utiliseront automatiquement le token renseigné.

Consulter les équipements connectés

Si vous souhaitez travailler avec les données des équipements connectés à votre compte, l’endpoint ci-dessous est l’un des plus importants :

GET /equipmentList

Il retourne la liste des équipements liés à l’entreprise, incluant leurs IDs respectifs.

Les IDs des équipements sont utilisés dans plusieurs endpoints de l’API.

Comment trouver l’ID d’un équipement

En plus de l’endpoint GET /equipmentList, il est également possible de localiser l’ID directement via la plateforme :

1. Accédez à l’onglet « Équipements »
2. Sélectionnez l’équipement souhaité
3. Ouvrez le tableau de bord individuel de l’équipement

L’ID sera affiché dans les informations de l’équipement.

Exemples d’utilisation de l’API

Avec l’API Externe de la Plateforme IOK, votre entreprise peut :

• Intégrer les équipements avec des systèmes propres
• Automatiser l’envoi de menus et recettes
• Développer des tableaux de bord personnalisés
• Créer des intégrations avec ERP et CRM
• Surveiller la télémétrie et les événements
• Automatiser les mises à jour logicielles
• Consolider les données opérationnelles dans des outils BI
• Développer des applications personnalisées pour l’opération

Observations importantes

• Chaque token possède une limite de requêtes par minute
• Le token est individuel et lié au compte utilisateur
• Nous recommandons que les intégrations soient développées par des professionnels de la technologie
• Certaines fonctionnalités peuvent varier selon le modèle de l’équipement

Besoin d’aide ?

Si vous avez des questions sur les intégrations ou l’utilisation de l’API Externe de la Plateforme IOK, contactez notre équipe de support via les canaux officiels de service de Prática.