Escopo

O objetivo desta documentação é apresentar os passos essenciais para consumir a API de consulta de informações do MOVERE, bem como orientar o acesso à documentação disponível no Swagger. 

Acesso ao Swagger

Para acessar o Swagger da API do MOVERE, basta informar no navegador uma URL semelhante a: “https://api.moveresoftware.com/swagger”. Após o acesso, você será redirecionado automaticamente para a página da documentação.

Em seguida, verifique se o dropdown localizado na parte superior da tela está selecionado com o endereço: “https://api.moveresoftware.com/swagger/docs/movere-api”.

Ao clicar em um grupo, as API's serão exibidas:

• Obs: as API's  riscadas estão obsoletas e não devem ser usadas. 

Obtenção do Token

Toda requisição realizada na MOVERE API deve conter o token de autenticação no header da requisição. Para obter esse token, é necessário realizar o login por meio da própria API.

No exemplo abaixo, o processo de autenticação está sendo realizado diretamente pelo Swagger.

Para efetuar o login, basta informar as seguintes credenciais:

• Usuário;
• Senha;
• Ambiente.

O usuário e a senha devem corresponder aos dados de acesso de um usuário do MOVERE que possua permissão na rotina [R1000 - Central de Integração]. Para configurar as permissões necessárias, siga as instruções disponíveis na base de conhecimento:

https://meajuda.moveresoftware.com/a/solutions/articles/27000068992

O ambiente será disponibilizado pela equipe do MOVERE.

Após preencher as informações, clique no botão “Try it out!”. A resposta da requisição retornará o token de autenticação, que deverá ser utilizado nas demais chamadas da API.

Realizando requisições na API via Swagger

Uma vez obtido o token, você deverá coloca no cabeçalho da página no campo Token (ao lado da URL) o texto Bearer + um espaço + o token sem as aspas. Somente o conteúdo:

Basta clicar em Explore e aguardar. Ele poderá apresentar a mensagem abaixo indicando que está se conectando:

Depois de conectado, pronto, a tela com as APIs estarão disponíveis para uso:

Realizando requisições na API via Postman

Para se realizar requisições de testes na API poderá ser utilizado o Postman, por exemplo, onde poderá ser adicionado o token no header da requisição, ou pela aba Authorization:

Após isso, será necessário montar o corpo da requisição, onde conterá o JSON que no Swagger é especificado como é o exemplo de parâmetro.

Para realizar a requisição preste atenção qual o verbo HTTP (GET, POST, PUT, DELETE) é necessário utilizar, esta informação também é fornecida no Swagger.

Obs: O Postman foi utilizado somente para realizar testes, sendo assim, o client utilizado sempre fica a escolha do desenvolvedor.