A Integração Genérica (API), é utilizada pelas empresas que precisam integrar o VExpenses com sistemas que não possuem integrações nativas com nossa plataforma. Saiba mais sobre integrações com nosso sistema lendo o artigo: Como Integrar o VExpenses com outros Sistemas?
Então, se sua empresa deseja realizar a integração API, basta seguir os passos descritos nesse artigo!
Sumário:
3. Configurações de códigos de De > Para
LÓGICA DA INTEGRAÇÃO API
A API do VExpenses funciona de forma que a empresa conecta o sistema com o qual precisa integrar com nossa API e envia frequentemente requisições (pedidos) via Json para que o VExpenses possa entregar as informações solicitadas.
Assim, a própria empresa pode consumir de nossa API, utilizando endpoints que foram criados pelo 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 e entre outros!
INÍCIO DA INTEGRAÇÃO
1. O primeiro passo a ser realizado, é solicitar nosso guia de integração Genérica (API) completo.
Nosso time de Suporte pode disponibiliza-lo para que você possa se guiar mais a fundo com bons exemplos durante a configuração. Entre em contato com suporte@vexpenses.com e solicite nosso guia!
2. Em seguida, é necessário que um usuário administrador da empresa (que já possui conta no VExpenses), vá até a aba "Configurações" e escolha a opção "Integrações". Nessa aba é possível encontrar um "Token Público", que é utilizado como chave para conectar a conta VExpenses da sua empresa com nossa API.
3. É necessário que a própria empresa realize o desenvolvimento da integração com o sistema que deseja. Dessa forma, o token público deve ser inserido no campo de autenticação do ERP ou sistema que a empresa estiver utilizando na integração.
4. Com o token conectado no sistema que deseja integrar, é possível enviar request pela linguagem Json para nossa API.
As requisições são feitas através de endpoints que respeitam 4 tipos de métodos, sendo eles:
POST - Para criar informações no VExpenses, como por exemplo, criar o cadastro de um usuário
PUT - Para atualiza nformações no VExpenses, como por exemplo, atualizar o CPF de um usuário que já foi cadastrado anteriormente
GET - Solicitar informações gerais, como por exemplo, todas as despesas aprovadas em um determinado período
DELETE - Deletar informações que já foram adicionadas no VExpenses anteriormente, como por exemplo, deletar um centro de custo existente.
5. Possuímos um ambiente de testes, onde é possível verificar todos os endpoints disponíveis e realizar requisições com eles para verificar, cadastrar, atualizar e deletar informações.
Ambiente de testes: https://developers.vexpenses.com/v2/
Acesse o ambiente de testes, conecte o token da sua empresa e teste os endpoints que podem ser utilizados!
6. É necessário respeitar o uso desses endpoints para solicitar informações para API do VExpenses, de forma que é possível adicionar "Includes" para solicitar informações, mas não é possível cadastrar novos endpoints.
CONFIGURAÇÃO DE CÓDIGOS DE > PARA
A empresa também pode configurar códigos específicos que condizem com o código de cada usuário, tipo de despesa, centro de custo e projetos cadastrados no 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, é necessário que um usuário administrador entre no VExpenses e clique em:
Configurações > Integrações > Integração Genérica > Configurar
Será possível identificar os códigos que podem ser configurados. Para cadastrar os códigos, basta clicar em "Editar", realizar o preenchimento e salvar.
No exemplo abaixo estamos informando que a usuária "Anna Teste", cadastrada no 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! Email: suporte@vexpenses.com