{"id":8084,"date":"2025-01-23T18:28:15","date_gmt":"2025-01-23T18:28:15","guid":{"rendered":"https:\/\/fox-plan.com\/?post_type=docs&p=8084"},"modified":"2025-01-23T18:41:15","modified_gmt":"2025-01-23T18:41:15","password":"","slug":"guide-dutilisation-de-lapi","status":"publish","type":"docs","link":"https:\/\/fox-plan.com\/fr\/docs\/guide-dutilisation-de-lapi\/","title":{"rendered":"Guide d'utilisation de l'API"},"content":{"rendered":"

Vue d'ensemble<\/h2>\n

L'API FoxPlan permet aux d\u00e9veloppeurs d'int\u00e9grer les fonctionnalit\u00e9s de gestion de projet de FoxPlan dans leurs applications. Ce guide propose une approche pas \u00e0 pas pour utiliser efficacement l'API afin de r\u00e9cup\u00e9rer et de g\u00e9rer les donn\u00e9es des projets.<\/p>\n

Tout d'abord, nous vous montrerons la documentation de l'API et le bac \u00e0 sable dans FoxPlan. Ensuite, nous vous montrerons comment utiliser l'API en mode autonome.<\/p>\n

Avis de non-responsabilit\u00e9<\/strong><\/h2>\n

L'utilisation de l'API FoxPlan se fait \u00e0 vos risques et p\u00e9rils. \u00c9tant donn\u00e9 que toutes les fonctionnalit\u00e9s sont disponibles via l'API, vous avez la possibilit\u00e9 de planter, d'effacer ou de corrompre vos donn\u00e9es. Nous recommandons vivement d'utiliser un environnement de test dans un premier temps.<\/strong> N'h\u00e9sitez pas \u00e0 nous contacter ; nous serons heureux de vous aider \u00e0 mettre en \u0153uvre l'API afin de garantir des performances optimales et la s\u00e9curit\u00e9 des donn\u00e9es.<\/p>\n

\n
\n<\/div>\n

Documentation de l'API dans FoxPlan<\/strong><\/h2>\n

Une documentation Swagger compl\u00e8te pour l'API est disponible dans le fichier Menu administrateur<\/strong> de votre compte FoxPlan. Utilisez cette ressource pour explorer les sp\u00e9cifications d\u00e9taill\u00e9es des points de terminaison et les options de test. Puisque vous \u00eates connect\u00e9 \u00e0 l'application, toute la partie s\u00e9curit\u00e9 est faite pour vous dans Swagger. Les acc\u00e8s de s\u00e9curit\u00e9 seront d\u00e9taill\u00e9s dans la section suivante.<\/p>\n

Pour acc\u00e9der \u00e0 la documentation swagger, allez dans le menu \"Settings > Workspace\" et l'onglet \"API\".<\/p>\n

\"Swagger\"<\/p>\n

Test d'API avec swagger<\/h2>\n

Par exemple, nous utiliserons swagger pour obtenir les vacances d'une ressource.<\/p>\n

Dans Swagger, allez \u00e0 l'API \"\/api\/vacances\" et cliquez sur \"Try it out\".<\/p>\n

\"Essai<\/p>\n

Vous pouvez ensuite saisir l'adresse \u00e9lectronique de la ressource pour laquelle vous souhaitez demander des cong\u00e9s et cliquer sur \"Ex\u00e9cuter\"<\/p>\n

\"API<\/p>\n

Vous obtiendrez la commande \"curl\" correspondante, l'URL et la r\u00e9ponse du serveur.<\/p>\n

\"R\u00e9ponse<\/p>\n

D\u00e9marrer avec l'API<\/h2>\n

Cr\u00e9er un compte API dans FoxPlan<\/h3>\n

L'API FoxPlan utilise une authentification bas\u00e9e sur un jeton. Avant d'effectuer des requ\u00eates, assurez-vous que vous disposez d'une cl\u00e9 API valide. Vous pouvez g\u00e9n\u00e9rer une cl\u00e9 API \u00e0 partir de votre compte FoxPlan dans la section API <\/strong>tabulation.<\/p>\n

\"Compte<\/p>\n

Saisissez un nom pour le compte et cliquez sur \"Add API account\". Vous obtiendrez l'\"Auth ID\" et l'\"Auth token\". Vous devez copier ces deux valeurs et les conserver en lieu s\u00fbr.<\/p>\n

\"AP\u00cf<\/p>\n

Vous devez encoder la cha\u00eene de caract\u00e8res \"authId:authToken\" en \"base64\". Vous pouvez le faire avec un outil comme https:\/\/www.utilities-online.info\/base64<\/a>. Le r\u00e9sultat sera utilis\u00e9 pour l'authentification de base de l'API ci-dessous.<\/p>\n

Accorder l'acc\u00e8s au compte API<\/h3>\n

Le compte API se verra accorder l'acc\u00e8s \u00e0 l'application avec des droits sp\u00e9cifiques.<\/p>\n

Cliquez sur \"Attribuer un r\u00f4le\" dans l'\u00e9cran pr\u00e9c\u00e9dent.<\/p>\n

\"Accorder<\/p>\n

Glissez-d\u00e9posez le compte API \"API_FoxPlan\" au bon endroit afin de lui donner un acc\u00e8s sp\u00e9cifique. Par exemple, vous pouvez le d\u00e9poser dans \"Workspace Manager\".<\/p>\n

Votre compte API est maintenant pr\u00eat \u00e0 \u00eatre utilis\u00e9.<\/p>\n

Essayez votre API \u00e0 partir de PostMan<\/h2>\n

Nous vous montrerons ensuite comment utiliser l'API avec PostMan. Dans la r\u00e9alit\u00e9, c'est votre code qui effectuera la requ\u00eate.<\/p>\n

Obtenez votre jeton API<\/h3>\n

Votre premi\u00e8re demande \u00e0 l'API consiste \u00e0 obtenir votre Token ID.<\/p>\n

Effectuer une requ\u00eate sur l'URL : https:\/\/app.fox-plan.com\/api\/auth<\/a><\/p>\n

Avec \"Authorization = Basic base64\" (base64 \u00e9tant la r\u00e9f\u00e9rence ci-dessus).<\/p>\n

\"ID<\/p>\n

Vous devez conserver le \"id_token\". Il sera utilis\u00e9 dans l'en-t\u00eate d'authentification pour interroger l'API.<\/p>\n

Autorisation : Bearer id_token<\/code><\/pre>\n
\n
\n<\/div>\n
Demande d'API<\/h2>\n
Nous sommes maintenant pr\u00eats \u00e0 ex\u00e9cuter le m\u00eame exemple que nous avons fait dans Swagger, mais cette fois nous allons ex\u00e9cuter la requ\u00eate \u00e0 partir de PostMan.<\/p>\n
Exemple de vacances<\/strong><\/h3>\n
Obtenir toutes les vacances d'une ressource<\/h4>\n
R\u00e9cup\u00e9rer une liste de vacances.<\/p>\n