Guia de uso da API FoxPlan

Visão geral

A API FoxPlan permite que os desenvolvedores integrem as capacidades de gerenciamento de projeto às suas aplicações, para recuperar e gerenciar os dados de projeto.

Aviso importante

Uso por sua conta e risco

«O uso da API FoxPlan é feito por sua conta e risco. Como todas as funcionalidades estão disponíveis via API, você tem a possibilidade de travar, excluir ou corromper seus dados.» É fortemente recomendado testar primeiro em um ambiente não produtivo.

Acessar a documentação da API

Uma documentação Swagger completa está disponível no FoxPlan via Configurações > Espaço de trabalho > aba API, com as especificações detalhadas dos endpoints para os usuários autenticados.

Documentação Swagger da API FoxPlan

Começar: três etapas principais

1. Criar uma conta de API

Na aba API, crie uma conta de API informando um nome. O sistema fornece um Auth ID e um Auth Token, que devem ser combinados e codificados em base64 para a autenticação.

Aba API: campo descrição e botão «Add API account»

Popup exibindo o Auth ID e o Auth Token da conta de API criada

2. Atribuir as permissões

Dê a essa conta de API funções específicas (por exemplo Workspace Manager) para determinar seus direitos na aplicação.

Atribuição de uma função à conta de API por arrastar e soltar na aba Membro

3. Obter um access token

Faça uma requisição a https://app.fox-plan.com/api/auth em autenticação Basic com suas credenciais codificadas em base64. A resposta contém um id_token a ser usado nas chamadas seguintes.

Requisição POST /api/auth no Postman retornando o id_token

Formato das requisições de API

Cabeçalhos padrão:

Authorization: Bearer <id_token>

Exemplo de endpoint:

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

No Swagger, expanda um endpoint e clique em Try it out para testá-lo diretamente:

Endpoint GET /api/vacations no Swagger com o botão «Try it out»

Preenchimento dos parâmetros e botão «Execute» no Swagger

Resposta 200 da API com o comando curl e o corpo JSON

A mesma chamada pode ser feita a partir de um cliente como o Postman, passando o Bearer <id_token> no cabeçalho Authorization:

Chamada de um endpoint com o Bearer token no Postman

Boas práticas

Respeite as políticas de limitação de taxa (rate limiting)
Implemente um tratamento de erros completo
Armazene as chaves de API de forma segura — nunca as codifique diretamente no código

Códigos de status HTTP

Código	Significado
200	Sucesso
400	Requisição inválida
401	Não autenticado
403	Proibido
404	Não encontrado
500	Erro de servidor

Visão geral​

Aviso importante​

Acessar a documentação da API​

Começar: três etapas principais​

1. Criar uma conta de API​

2. Atribuir as permissões​

3. Obter um access token​

Formato das requisições de API​

Boas práticas​

Códigos de status HTTP​