Para utilização da API CRM Viasoft é necessário acessar o Esse documento tem como objetivo descrever as APIs disponíveis no produto CRM.
Para testar os endpoints disponibilizamos uma documentação utilizando a ferramenta swagger, no seguinte link:
http://crm-dev.viasoftcloud.com.br/api/swagger-ui/index.html# (Ainda não disponível).
...
Após essa operaçãoPrimeiramente, será necessário autententicar o usuário, para isso deve ser utilizados os endpoints de autenticação.
...
Para determinar em qual cliente o usuário deseja se autenticar ele pode utilzar o endpoint empresas-do-usuario. Nesse endpoint ele deve informar o seu usuário e senha, para obter uma lista com os clientes que tem acesso e o id de cada um deles.
Ex:
...
Em seguida, deve-se utilizar o endpoint oauth/token passando seu username e password, bem como o id do cliente em que deseja se conectar.
...
Como resposta ele deverá obter um token de acesso.
...
Esse token é 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 em no botão “Authorize”, no campo superior direito e informar o token no campo solicitado.
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:
...
Com isso o usuário poderá fazer as demais requisições da API.
...