Este artigo é direcionado a usuários Administradores e explica como configurar a integração da VExpenses via API com outros sistemas de gestão.
A integração via API permite conectar a VExpenses ao seu sistema, enviando e recebendo dados automaticamente por meio de requisições (pedidos) no formato JSON.
Saiba mais sobre integrações no artigo: Como Integrar o VExpenses com outros Sistemas?
Sumário:
1. Como funciona a Integração API
3. Como configurar códigos de integração (De/Para)
Como funciona a Integração API
A integração é realizada por meio de requisições enviadas pelo seu sistema para a API da VExpenses. Assim, a própria empresa pode consumir de nossa API, utilizando endpoints que foram criados pela VExpenses, e, assim, retornaremos repostas com as informações necessárias.
Dessa forma, é possível solicitar as despesas de determinados usuários para pagamentos em ERPs, sistemas de gestão, entre outros.
Como iniciar a Integração
1. Solicite o Guia Completo de Integração (API) ao time de Suporte pelo e-mail: suporte@vexpenses.com, para informações detalhadas da integração.
2. Em seguida, o usuário administrador da empresa, que já possui conta na VExpenses, deve acessar a aba "Configurações" e clicar em "Integrações".
Localize e copie o Token Público. Este token será utilizado como chave de autenticação da integração entre a VExpenses e a API.
3. A própria empresa realiza o desenvolvimento da integração com o sistema que deseja. Dessa forma, insira o Token Público no campo de autenticação do ERP ou sistema que será integrado à VExpenses.
4. A partir disso, sua equipe poderá iniciar o desenvolvimento da integração e enviar requisições para a API. As requisições são feitas através de endpoints que respeitam 4 tipos de métodos, sendo eles:
- POST: criar novos registros (ex: cadastro de usuário)
- PUT: atualizar registros existentes
- GET: consultar informações (ex: despesas aprovadas)
- DELETE: remover registros (ex: deletar centros de custo)
A VExpenses disponibiliza um ambiente de testes para validação das requisições e consulta dos endpoints disponíveis. Acesse: https://developers.vexpenses.com/v2/
Nesse ambiente, é possível: testar requisições; validar retornos da API; simular integrações antes da implementação em produção. Para utilizar, basta inserir o Token Público da sua empresa.
Ao utilizar a API da VExpenses, é importante considerar que não é possível criar novos endpoints; é permitido utilizar parâmetros como includes para complementar os dados das requisições e todas as requisições devem seguir os padrões definidos pela API
Como configurar códigos de integração (De/Para)
É possível configurar códigos específicos que condizem com o código de cada usuário, tipo de despesa, centro de custo e projetos cadastrados na VExpenses.
Essas informações farão com que os requests solicitados pela empresa possam trazer ainda mais informações que serão combinadas com os itens que a empresa configurou previamente no ERP. Para isso, acesse:
Configurações > Integrações > Integração Genérica > Configurar
Para cadastrar os códigos que deseja configurar, clique em "Editar", realize o preenchimento e salve.
No exemplo abaixo estamos informando que a usuária "Anne Campos", cadastrada na VExpenses, corresponde ao código "25689771" do ERP ou sistema que está conectado com a integração.
Caso você possua dúvidas sobre a integração API, entre em contato com nosso time de Suporte para que possamos te auxiliar! E-mail: suporte@vexpenses.com