Introdução à API do Fipli
Bem-vindo à documentação da API do Fipli! Esta API foi projetada para fornecer acesso programático às funcionalidades da plataforma Fipli, permitindo que desenvolvedores integrem e utilizem os recursos financeiros de forma eficiente e escalável.
URL Base
A URL base para todas as requisições à API do Fipli é: https://portal.fipli.pro/api/v1
Autenticação
Para interagir com a API, é necessário utilizar um token de acesso que deve ser incluído nas requisições. Este token garante a segurança e a integridade dos dados durante a comunicação com os servidores do Fipli.
Token de acesso
Para obter uma token de acesso, siga os passos abaixo:
- Acesse o perfil na parte superior direita da página e selecione o nome do usuário.
- Uma janela será aberta com duas abas:
PerfileAPI. - Selecione a aba API e, em seguida, clique em Gerar Token e Copiar.
Observação: Esse token só poderá ser visto uma única vez. Após gerá-lo, copie-o e armazene-o em um local seguro.
Esse token de acesso será usada em todas as requisições da nossa API, em um parâmetro no body chamado access_token.
Token da Unidade
As requisições para a API também necessitam ter outro parâmetro chamado unit_token, que identifica a unidade. Esse token da unidade pode ser conseguido na parte de listagem de Unidades no Fipli. Para isso, selecione Editar na unidade desejada. Lá haverá um campo chamado Token API.
Estrutura da Documentação
Esta documentação está organizada por seções, abrangendo diferentes módulos da API, como despesas, receitas, relatórios e administração de usuários. Cada seção inclui detalhes sobre os endpoints disponíveis, exemplos de requisições e respostas, parâmetros necessários, e códigos de status.
Sinta-se à vontade para explorar as diferentes funcionalidades e comece a integrar a API do Fipli em suas aplicações!