Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

http://crm-dev.viasoftcloud.com.br/api/swagger-ui/index.html# (Ainda não disponível).

Primeiramente, é necessário gerar um token de acesso através do endpoint “oauth/token”, conforme exemplo a seguir.

...

Essa requisição deve retornar a seguinte resposta:

...

O token de acesso tem duração de duas horas, e deve ser utilizado para realizar as demais requisições. Para isso, deve-se clicar no botão “Authorize”, na parte superior da página, colar o token gerado e clicar novamente em “Authorize”.

...

Feito isso, o usuário estará autenticado para realizar as demais requisições

Caso o usuário possua acesso à diversas empresas, é possível também especificar em qual deseja se autenticar. Para isso, basta informar o campo “idClient” no corpo da requisição, informando o código da empresa, conforme exemplo:

...

Para saber o código da empresa, pode-se utilizar o endpoint empresas-do-usuario. Conforme exemplo a seguir:

...

A resposta irá retornar todas as empresas que o usuário possui acesso:

...

Para testar os endpoints no swagger, primeiramente é necessário se autenticar no sistema. Conforme documentado na página:

Com isso o usuário poderá fazer as demais requisições da API.

...