API publique de Recipok et jetons d’accès
Offre Intégral
Comment créer et révoquer les jetons de l’API, quelles données peuvent être lues et écrites et où trouver la documentation pour votre informaticien.
À quoi ça sert
L’API publique est la porte qui permet à un autre logiciel de lire et d’écrire dans votre compte Recipok sans que personne ne recopie de données à la main : votre boutique en ligne qui crée des commandes, votre logiciel de gestion qui récupère les bons de livraison, un tableur qui consulte le stock chaque matin.
Chaque logiciel se connecte avec un jeton (token), une longue clé que vous créez, que vous remettez à la personne qui réalise la connexion et que vous pouvez révoquer quand vous le souhaitez. Cet article s’adresse au gérant qui doit créer cette clé et à l’informaticien qui va l’utiliser.
Avant de commencer
- Les jetons font partie de l’offre Intégral.
- Ils sont créés par un utilisateur ayant le rôle de responsable ou d’administrateur.
- Il vous faut quelqu’un pour programmer la connexion : la personne qui maintient votre logiciel de gestion ou votre informaticien. Si vous n’en avez pas, consultez Connectez Recipok à votre facturation, votre comptabilité ou votre caisse : nous réalisons aussi des intégrations sur mesure.
Où le trouver
Dans le menu de votre compte, en haut à droite, ouvrez Intégrations puis l’onglet API Token. L’écran Options du développeur affiche les mêmes informations ; avec une offre autre qu’Intégral, il se contente de décrire l’API et indique que votre offre ne permet pas de créer de jetons.
1URL de base de l’API : https://api.recipok.com · En-tête d’authentification · Exemple de requête
Consultez la documentation complète de l’API
| Nom | Statut | |
|---|---|---|
| Boutique en ligne | Conservé de manière sécurisée | 2Supprimer |
Nom du jeton : Ex. : Intégration Zapier, développement local, etc.
3Générer un jeton
- 1Les informations pour votre informaticien : l’adresse de l’API, l’en-tête dans lequel va le jeton et un exemple prêt à copier.
- 2Chaque jeton a un nom : vous savez ainsi quel logiciel l’utilise et lequel supprimer.
- 3Générer un jeton crée la clé et vous l’affiche une seule fois.
Créer un jeton
Donnez-lui un nom
Dans Créer un nouveau jeton, indiquez dans Nom du jeton à quoi il sert : « Boutique en ligne », « Cabinet comptable », « Tests de l’informaticien ». Un jeton par logiciel.
Cliquez sur Générer un jeton
L’avis Copiez ce jeton maintenant apparaît. Cliquez sur Copier et conservez-le en lieu sûr ou envoyez-le directement à la personne qui réalisera la connexion.
Confirmez
Lorsque vous cliquez sur Confirmer, le jeton est masqué pour toujours. Dans la liste, il apparaît comme « Conservé de manière sécurisée » : Recipok le stocke chiffré et personne ne peut plus le lire.
Révoquer des jetons
- Pour retirer une clé, supprimez-la depuis Vos jetons avec Supprimer. Le logiciel qui l’utilisait ne peut plus se connecter, immédiatement.
- L’administrateur voit en plus les Tokens des autres utilisateurs, avec leur propriétaire, et peut utiliser Révoquer le token sur n’importe lequel d’entre eux. C’est utile quand quelqu’un quitte l’entreprise.
Un jeton donne accès aux données de votre entreprise. Ne le collez pas dans des e-mails envoyés à plusieurs personnes ni dans des documents partagés, et créez-en un différent pour chaque logiciel : vous pourrez ainsi en couper un sans arrêter les autres.
Ce qu’un logiciel peut faire avec l’API
| Domaine | Exemples |
|---|---|
| Recettes | Consulter les recettes avec leurs ingrédients, formats, prix et TVA, ainsi que les informations nutritionnelles. |
| Ingrédients et fournisseurs | Lire et créer des ingrédients ; consulter les fournisseurs. |
| Achats et stock | Enregistrer des réceptions de marchandise et consulter ou ajuster le stock. |
| Production | Créer des ordres de production, attribuer des lots et les terminer. |
| Ventes | Créer des commandes de vente, les marquer comme livrées, enregistrer des sorties avec leurs lots et consulter ou créer des clients. |
| HACCP | Enregistrer et consulter les registres HACCP et les emplacements. |
Pour votre informaticien
- La documentation technique complète se trouve sur api.recipok.com/api/doc (bouton Consultez la documentation complète de l’API). Elle est disponible en plusieurs langues.
- L’API répond sur son propre domaine : les requêtes envoyées à l’adresse avec laquelle vous vous connectez à Recipok ne lui parviennent pas.
- Le jeton va dans l’en-tête d’authentification indiqué à l’écran, à chaque requête.
- Unités impériales, en option. Si l’intégration travaille en livres, en onces ou en degrés Fahrenheit, elle peut le demander avec l’en-tête X-Unit-System :
imperial_uk,us_customary,account(les unités configurées dans votre compte) oumetric. Sans cet en-tête, tout reste dans le système métrique, comme toujours.
Avant de connecter un nouveau logiciel à votre compte réel, demandez à votre informaticien de tester avec peu de données et vérifiez dans Recipok ce qu’il a créé. Les questions sur l’API se règlent dans le chat du support.