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
«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 > Conectores > aba API, com as especificações detalhadas dos endpoints para os usuários autenticados.
A documentação exige uma sessão no FoxPlan (a especificação /v3/api-docs não é pública). O botão Authorize do Swagger aceita o id_token obtido abaixo; os pedidos «Try it out» são enviados ao servidor FoxPlan que serviu a página. As funções internas do FoxPlan (cache, exploração, conectores) não aparecem nesta documentação.
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.
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.
Esse papel não custa nada: uma conta de API não consome nenhuma licença de usuário, mesmo com um papel de administrador do espaço de trabalho. Ela aparece em Parâmetros > Conta FoxPlan > Usuário e licença com a menção «Conta de API» em vez de um tipo de licença.
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.
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:
A mesma chamada pode ser feita a partir de um cliente como o Postman, passando o Bearer <id_token> no cabeçalho Authorization:
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 |