Guide d'utilisation de l'API FoxPlan

Vue d'ensemble

L'API FoxPlan permet aux développeurs d'intégrer les capacités de gestion de projet dans leurs applications, pour récupérer et gérer les données de projet.

Avertissement important

Utilisation à vos risques et périls

« L'utilisation de l'API FoxPlan se fait à vos risques et périls. Toutes les fonctionnalités étant disponibles via l'API, vous avez la possibilité de planter, supprimer ou corrompre vos données. » Il est fortement recommandé de tester d'abord dans un environnement non productif.

Accéder à la documentation de l'API

Une documentation Swagger complète est disponible dans FoxPlan via Paramètres > Espace de travail > onglet API, avec les spécifications détaillées des endpoints pour les utilisateurs authentifiés.

Documentation Swagger de l'API FoxPlan

Démarrer : trois étapes clés

1. Créer un compte API

Dans l'onglet API, créez un compte API en saisissant un nom. Le système fournit un Auth ID et un Auth Token, qui doivent être combinés et encodés en base64 pour l'authentification.

Onglet API : champ description et bouton « Add API account »

Popup affichant l'Auth ID et l'Auth Token du compte API créé

2. Attribuer les permissions

Donnez à ce compte API des rôles spécifiques (par exemple Workspace Manager) pour déterminer ses droits dans l'application.

Attribution d'un rôle au compte API par glisser-déposer dans l'onglet Membre

3. Obtenir un access token

Faites une requête à https://app.fox-plan.com/api/auth en authentification Basic avec vos identifiants encodés en base64. La réponse contient un id_token à utiliser pour les appels suivants.

Requête POST /api/auth dans Postman renvoyant l'id_token

Format des requêtes API

En-têtes standard :

Authorization: Bearer <id_token>

Exemple d'endpoint :

GET https://app.fox-plan.com/api/vacations?email=prenom.nom@domaine.com

Depuis Swagger, dépliez un endpoint puis cliquez sur Try it out pour le tester directement :

Endpoint GET /api/vacations dans Swagger avec le bouton « Try it out »

Saisie des paramètres et bouton « Execute » dans Swagger

Réponse 200 de l'API avec la commande curl et le corps JSON

Le même appel peut être réalisé depuis un client comme Postman, en passant le Bearer <id_token> dans l'en-tête Authorization :

Appel d'un endpoint avec le Bearer token dans Postman

Bonnes pratiques

Respectez les politiques de limitation de débit
Implémentez une gestion d'erreur complète
Stockez les clés API de manière sécurisée — ne jamais les coder en dur

Codes de statut HTTP

Code	Signification
200	Succès
400	Requête invalide
401	Non authentifié
403	Interdit
404	Non trouvé
500	Erreur serveur

Vue d'ensemble​

Avertissement important​

Accéder à la documentation de l'API​

Démarrer : trois étapes clés​

1. Créer un compte API​

2. Attribuer les permissions​

3. Obtenir un access token​

Format des requêtes API​

Bonnes pratiques​

Codes de statut HTTP​