Vue d'ensemble #
L'API FoxPlan permet aux développeurs d'intégrer les fonctionnalités de gestion de projet de FoxPlan dans leurs applications. Ce guide propose une approche pas à pas pour utiliser efficacement l'API afin de récupérer et de gérer les données des projets.
Tout d'abord, nous vous montrerons la documentation de l'API et le bac à sable dans FoxPlan. Ensuite, nous vous montrerons comment utiliser l'API en mode autonome.
Avis de non-responsabilité #
L'utilisation de l'API FoxPlan se fait à vos risques et périls. Étant donné que toutes les fonctionnalités sont disponibles via l'API, vous avez la possibilité de planter, d'effacer ou de corrompre vos données. Nous recommandons vivement d'utiliser un environnement de test dans un premier temps. N'hésitez pas à nous contacter ; nous serons heureux de vous aider à mettre en œuvre l'API afin de garantir des performances optimales et la sécurité des données.
Documentation de l'API dans FoxPlan #
Une documentation Swagger complète pour l'API est disponible dans le fichier Menu administrateur de votre compte FoxPlan. Utilisez cette ressource pour explorer les spécifications détaillées des points de terminaison et les options de test. Puisque vous êtes connecté à l'application, toute la partie sécurité est faite pour vous dans Swagger. Les accès de sécurité seront détaillés dans la section suivante.
Pour accéder à la documentation swagger, allez dans le menu "Settings > Workspace" et l'onglet "API".
Test d'API avec swagger #
Par exemple, nous utiliserons swagger pour obtenir les vacances d'une ressource.
Dans Swagger, allez à l'API "/api/vacances" et cliquez sur "Try it out".
Vous pouvez ensuite saisir l'adresse électronique de la ressource pour laquelle vous souhaitez demander des congés et cliquer sur "Exécuter"
Vous obtiendrez la commande "curl" correspondante, l'URL et la réponse du serveur.
Démarrer avec l'API #
Créer un compte API dans FoxPlan #
L'API FoxPlan utilise une authentification basée sur un jeton. Avant d'effectuer des requêtes, assurez-vous que vous disposez d'une clé API valide. Vous pouvez générer une clé API à partir de votre compte FoxPlan dans la section API tabulation.
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ûr.
Vous devez encoder la chaîne de caractères "authId:authToken" en "base64". Vous pouvez le faire avec un outil comme https://www.utilities-online.info/base64. Le résultat sera utilisé pour l'authentification de base de l'API ci-dessous.
Accorder l'accès au compte API #
Le compte API se verra accorder l'accès à l'application avec des droits spécifiques.
Cliquez sur "Attribuer un rôle" dans l'écran précédent.
Glissez-déposez le compte API "API_FoxPlan" au bon endroit afin de lui donner un accès spécifique. Par exemple, vous pouvez le déposer dans "Workspace Manager".
Votre compte API est maintenant prêt à être utilisé.
Essayez votre API à partir de PostMan #
Nous vous montrerons ensuite comment utiliser l'API avec PostMan. Dans la réalité, c'est votre code qui effectuera la requête.
Obtenez votre jeton API #
Votre première demande à l'API consiste à obtenir votre Token ID.
Effectuer une requête sur l'URL : https://app.fox-plan.com/api/auth
Avec "Authorization = Basic base64" (base64 étant la référence ci-dessus).
Vous devez conserver le "id_token". Il sera utilisé dans l'en-tête d'authentification pour interroger l'API.
Autorisation : Bearer id_token
Demande d'API #
Nous sommes maintenant prêts à exécuter le même exemple que nous avons fait dans Swagger, mais cette fois nous allons exécuter la requête à partir de PostMan.
Exemple de vacances #
Obtenir toutes les vacances d'une ressource #
Récupérer une liste de vacances.
- Point final: https://app.fox-plan.com/api/vacations
- Méthode:
GET
- Paramètres de la requête : nomprenom@domain.com
- Autorisation : Bearer id_token
Exemple de réponse :
Félicitations, vous avez réussi à récupérer des informations par l'intermédiaire de l'API.
Meilleures pratiques #
- Limites de taux: Respecter les limites du taux de l'API .
- Gestion des erreurs: Mettre en œuvre un traitement robuste des erreurs pour gérer les réponses telles que
400 Mauvaise demande
ou500 Erreur de serveur interne
. - Sécurité des données: Stockez les clés d'API en toute sécurité et évitez de les coder en dur dans vos applications.
Codes d'erreur #
Code | Description |
---|---|
200 | Succès |
400 | Mauvaise demande |
401 | Non autorisé |
403 | Interdit |
404 | Ressource non trouvée |
500 | Erreur de serveur interne |
Pour obtenir une aide supplémentaire, contactez notre équipe d'assistance.