ㅤTempo de leitura – 6 minutos
ㅤFinmap
ㅤ
Informações gerais 🖇️
ㅤAPI (Application Programming Interface) — é um conjunto de classes prontas, procedimentos, funções, estruturas e constantes fornecidas por um aplicativo (biblioteca, serviço) para uso em produtos de software externos. A API atua como um intermediário entre o desenvolvedor do aplicativo e qualquer ambiente com o qual o aplicativo deve interagir.
ㅤO Finmap tem uma API aberta que pode ser usada pelos usuários para suas próprias necessidades e para personalizar integrações individuais com o serviço. Você pode visualizar informações sobre a API na seção Configurações – Configurações da empresa, bloco – Desenvolvedores. Aqui você encontrará informações sobre a documentação da API.
📎 Ou você pode encontrá-lo aqui: https://api.finmap.online/
ㅤ
ㅤA chave API é uma chave de criptografia para autenticação do usuário no sistema, semelhante a um login e senha.
ㅤA documentação da API Finmap é baseada no recurso Swagger
ㅤ
Blocos na documentação do ARI 📁
ㅤ
ㅤA documentação está dividida em blocos:
- webhooks – um bloco que ajuda a trabalhar com webhooks
- default – verificar a funcionalidade geral
- currencies – mostra em quais moedas você pode abrir uma empresa
- accounts – trabalhar com contas
- tags – trabalhar com tags
- projects – trabalhar com projetos
- categories/income – trabalhar com categorias de receita
- categories/expense – trabalhar com categorias de despesa
- customers – trabalhar com clientes
- investors – trabalhar com investidores
- creditors – trabalhar com credores
- debitors – trabalhar com mutuários
- suppliers – trabalhar com fornecedores
- employees – trabalhar com funcionários
- owners – trabalhar com proprietários
- operations/income – trabalhar com transações de receita
- operations/expense – trabalhar com transações de despesa
- operations/transfer – trabalhar com transferências
ㅤ
ㅤ
ㅤPara certos blocos, você pode visualizar, editar, excluir e adicionar. Esses blocos incluem:
- tags
- projects
- categories/income
- categories/expense
- customers
- investors
- creditors
- debitors
- suppliers
- employees
- owners
ㅤ
ㅤ
ㅤPor meio dos blocos a seguir, você pode adicionar apenas operações. Eles incluem:
- operations/income
- operations/expense
- operations/transfer
ㅤ
❌ A exceção é o bloco de contas; através deste bloco, você só pode receber informações sobre quais contas estão no serviço
ㅤ
ㅤㅤ
Métodos de consulta ⚙️
ㅤ
DELETE — exclui dados.
GET — usado para obter ou ler dados. Solicitações com este método podem apenas recuperar dados.
PATCH — geralmente é usado para atualizar um recurso substituindo os dados da solicitação.
POST — geralmente é usado para criar um novo recurso, e ninguém verá essas informações após o envio.