Árvore de páginas

Versões comparadas

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

...

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):

...


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

v4

Integration-Service

customer

Integration-Resource

customers-integration

Integration-Action

create

Integration-Responsedefine o nível de resposta. Existem dois níveis de retorno de requisição:

...

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, o corpo da requisição (body) deve estar vazio. Ao realizar a requisição, no corpo da resposta será retornado um JSON com as 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ção

...