Guía de uso de la API de FoxPlan

Visión general

La API de FoxPlan permite a los desarrolladores integrar las capacidades de gestión de proyectos en sus aplicaciones, para recuperar y gestionar los datos de proyecto.

Advertencia importante

Uso bajo su propia responsabilidad

«El uso de la API de FoxPlan se realiza bajo su propia responsabilidad. Al estar todas las funcionalidades disponibles a través de la API, tiene la posibilidad de bloquear, eliminar o corromper sus datos.» Se recomienda encarecidamente probar primero en un entorno no productivo.

Acceder a la documentación de la API

Una documentación Swagger completa está disponible en FoxPlan a través de Ajustes > Espacio de trabajo > pestaña API, con las especificaciones detalladas de los endpoints para los usuarios autenticados.

Documentación Swagger de la API de FoxPlan

Primeros pasos: tres etapas clave

1. Crear una cuenta API

En la pestaña API, cree una cuenta API introduciendo un nombre. El sistema proporciona un Auth ID y un Auth Token, que deben combinarse y codificarse en base64 para la autenticación.

Pestaña API: campo descripción y botón «Add API account»

Ventana emergente que muestra el Auth ID y el Auth Token de la cuenta API creada

2. Asignar los permisos

Otorgue a esta cuenta API roles específicos (por ejemplo Workspace Manager) para determinar sus derechos en la aplicación.

Asignación de un rol a la cuenta API mediante arrastrar y soltar en la pestaña Miembro

3. Obtener un access token

Realice una petición a https://app.fox-plan.com/api/auth con autenticación Basic y sus credenciales codificadas en base64. La respuesta contiene un id_token que se utilizará en las llamadas siguientes.

Petición POST /api/auth en Postman que devuelve el id_token

Formato de las peticiones API

Cabeceras estándar:

Authorization: Bearer <id_token>

Ejemplo de endpoint:

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

Desde Swagger, despliegue un endpoint y haga clic en Try it out para probarlo directamente:

Endpoint GET /api/vacations en Swagger con el botón «Try it out»

Introducción de parámetros y botón «Execute» en Swagger

Respuesta 200 de la API con el comando curl y el cuerpo JSON

La misma llamada puede realizarse desde un cliente como Postman, pasando el Bearer <id_token> en la cabecera Authorization:

Llamada a un endpoint con el Bearer token en Postman

Buenas prácticas

Respete las políticas de limitación de peticiones
Implemente una gestión de errores completa
Almacene las claves API de forma segura — nunca las escriba directamente en el código

Códigos de estado HTTP

Código	Significado
200	Éxito
400	Petición no válida
401	No autenticado
403	Prohibido
404	No encontrado
500	Error del servidor

Visión general​

Advertencia importante​

Acceder a la documentación de la API​

Primeros pasos: tres etapas clave​

1. Crear una cuenta API​

2. Asignar los permisos​

3. Obtener un access token​

Formato de las peticiones API​

Buenas prácticas​

Códigos de estado HTTP​