Este artigo é direcionado a usuários Administradores e explica como utilizar a integração API para cadastrar novos membros de equipe na VExpenses!
Para entender o que é a integração API, consulte o artigo: Como integrar a VExpenses via API (integração genérica)?
ENDPOINT PARA CADASTRO DE MEMBROS
1. Para realizar a criação de novos membros de equipe a configuração da API deve estar devidamente realizada.
A VExpenses disponibiliza um ambiente para 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. Acesse o ambiente de testes no 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. Conecte o token da sua empresa no campo "Authentication".
O token da empresa pode ser verificado, por um administrador, na aba de "Configurações" > "Integrações", onde é possível encontrar um token público contendo letras e números.
Copie o token para adicioná-lo no campo "Authentication" do ambiente teste. Ao colar o token neste campo, clique em "Set" para realizar a conexão.
3. Em seguida, 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
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 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!