A sua empresa utiliza a integração Genérica (API) da VExpenses para se conectar com ERPs ou outros sistemas?

Nesse artigo, explicaremos como é possível utilizar a integração para cadastro de novos membros de equipe na VExpenses! 

Sumário: 

1. Conexão da integração API

2. Endpoint para cadastro de membros 

CONEXÃO DA INTEGRAÇÃO API

Antes de realizar os próximos passos, a empresa precisa estar com a integração genérica (API) devidamente configurada. Para entender como é feita a configuração dessa integração, leia o artigo: Integração API: Como integrar com seu ERP e siga os passos indicados. 

ENDPOINT PARA CADASTRO DE MEMBROS 

1. A VExpenses disponibiliza um ambiente de testes onde é possível testar os endpoints da nossa API pública, para entender a lógica de cada uma das ações que podem ser realizadas através da integração.

Você pode entrar diretamente no ambiente de testes, através do link: https://developers.vexpenses.com/v2/

No dia a dia essas requisições não são feitas pelo ambiente de
testes da VExpenses, mas sim pelo sistema que sua empresa estará
utilizando para se comunicar com nossa API. Todas as ações devem
ser realizadas através dos nossos endpoints disponíveis que estão
exemplificados no ambiente de testes.

2. Em seguida, conecte o token da sua empresa no campo "Authentication".

O token da empresa precisa ser verificado através da conta de um administrador da empresa. Ele deve ir até a aba "Configurações" e selecionar a opção "Integrações", onde é possível encontrar um token público contendo letras e números.

Copie o token para adicioná-lo no campo "Authentication". Ao colar o token neste campo, clique em "Set" para realizar a conexão. 

3. No ambiente de testes, busque pela seção "Team Members", endpoint "Inserts a team member object".

Esse endpoint será indicado pelo método de comunicação "POST", uma vez que a ação que está sendo requerida é a de cadastro/criação de informações na plataforma. 

4. Neste endpoint, clique em "EXAMPLE" e preencha no corpo os dados necessários para a criação do usuário seguindo o padrão definido em "MODEL".

As informações obrigatórias para o cadastro do membro são: 

• integration_id;
• external_id;
• user_type;
• name;
• email;
• password;
• birth_date;
• active

Obs: No campo "example" deixamos diversos campos opcionais que podem ser adicionados no cadastro do usuário, mas caso queira realizar o cadastro sem algumas das informações opcionais, basta excluir os campos da requisição, deixando-a apenas com as informações que necessita. 

5. Por fim, finalize a requisição, clicando em "TRY" para enviar a requisição a nossa API. 

Se a ação for concluída com sucesso, uma mensagem indicará que o cadastro foi realizado. Assim, o usuário terá sido criado na VExpenses e já poderá fazer login com o e-mail e senha definidos no momento do cadastro.

Caso a ação não seja concluída com sucesso, retornaremos uma resposta indicando os motivos dos erros para que você possa corrigir e tentar novamente.

6. Após o cadastro, o usuário ficará disponível na listagem de membros da empresa, em Configurações > Membros de Equipe na VExpenses.

Caso tenha dúvidas ou dificuldades com o uso, entre em contato conosco pelo chat de suporte ou pelo e-mail: suporte@vexpenses.com, teremos o prazer de te ajudar!