...
Utilize esta URL: https://totvscrm.app/api/login
...
Todos os recursos estão disponíveis no Git Lab, nesta url: https://gitlab.wssim.com.br/docs/api/-/tree/master/integrationpublicamente para consultas neste endereço.
Vamos utilizar como exemplo o recurso de clientes (customers). Note que, dentro da documentação da API, temos tudo que precisamos (URL, o método HTTP e a extensão da URL):
...
Note que os acompanhados por "*", são obrigatórios;
Integration-Action: ação a ser realizada na API de integração. São suportadas as ações:
...
upsert: possui dois comportamentos, podendo atuar como atualização ou inserção. O que determina o comportamento é o conteúdo informado no header Integration-Filter. Se o registro informado já existir no CRM, é realizada uma atualização completa do registro presente no CRM, substituindo todo o conteúdo presente no CRM pelo conteúdo enviado na requisição. Se o ID não estiver presente no CRM, é feita uma inserção do conteúdo enviado na requisição;
Integration-Service: serviço responsável pela entidade. Por exemplo: customer;
Integration-Resource: recurso para requisição. Por exemplo: customers-integration;
Integration-Version: versão do contrato da API de integração. Deve ser utilizado a versão mais recente disponível de cada API para ter acesso à atributos personalizados. Por exemplo: v1;
Integration-Filter: usado nas ações de update e upsert como identificador do registro a ser atualizado ou quando a consulta realizada for um GET, atua como filtro de registros, sendo suportado
o formato RestQuery para a filtragem. Para o exemplo de criação de cliente com a ação create, não é
suportado o uso deste header:
KEY | VALUE |
Integration-Version | V1v4 |
Integration-Service | customer |
Integration-Resource | customers-integration |
Integration-Action | create |
Integration-Response: define o nível de resposta. Existem dois níveis de retorno de requisição:
Caso não seja informado o header Integration-Response na requisição, o retorno será equivalente ao nível minimum.
...
Após executar a requisição, você deverá receber um retorno ‘200’, e será retornado no corpo o ID do cliente cadastrado no CRM.
...
Note que é possível utilizar filtros na requisição da API de Integração. Saiba mais sobre filtros na requisição da API de Integração.
Para listar os clientes, não é necessário enviar o corpo da requisição (body) deve estar vazio. Ao realizar a requisição, no corpo da resposta será retornado um JSON com as lista listas de clientes.
Para mais informações sobre outros recursos da API do TOTVS CRM, acesse a documentação da API no Git Lab.
...
Artigos relacionados:
IntroduçãoComo realizar solicitações
Formato, métodos e retorno das requisições