Histórico da Página

...

Informações

title	API's

Expandir

title	Integração de eventos

O objetivo é disponibilizar uma api de integração de eventos ao WSH;

Para utilizar a api, deverá ser instalado o serviço winthor-integracao-config na versão 1.35.1.16 ou superior.

Totvs custom tabs box

tabs	Request, Response
ids	item1-apiEvento,item2-apiEvento

Totvs custom tabs box items

default	yes
referencia	item1-apiEvento

O envio da requisição de eventos deverá ser realizado no seguinte endpoint:

winthor/integracao/fulfillment/v1/evento método POST;

O JSON deverá respeitar a seguinte estrutura:

Bloco de código

language	js

{
	"origem": "ORIGEM",
	"codigoOrigem": "CODIGOORIGEM",
	"token": "bf602066-d434-47c6-9930-37fcd6891300",
	"codigoProcesso": 1,
	"descricaoProcesso": "DESCRICAO",
    "observacao":"OBSERVACAO"
}

Campo	Tipo	Descrição	Obrigatório
origem	String (50)	Origem do evento.	Sim
codigoOrigem	String (100)	Código de identificação da origem do evento	Sim
token	String	Token de identificação da requisição;	Não
codigoProcesso	Long (10)	Código do processo referente ao evento.	Sim
descricaoProcesso	String (200)	Descrição do processo referente ao evento.	Não
observacao	String	Observação sobre o evento.	Não

Totvs custom tabs box items

default	no
referencia	item2-apiEvento

Casa respeitados os campos de envio da requisição, o response deverá apresentar a seguinte estrutura:

HttpStatusCode 201 CREATED;
Um objeto contendo o evento inserido;

Ex:

Bloco de código

language	js

{
    "origem": "ORIGEM",
    "codigoOrigem": "CODIGOORIGEM",
    "token": "bf602066-d434-47c6-9930-37fcd6891300",
    "descricaoProcesso": "DESCRICAO",
    "observacao": "OBSERVACAO",
    "codigoProcesso": 1,
    "dataCriacao": "2024-04-24T15:31:10.482",
    "dataAlteracao": "2024-04-24T15:31:10.482",
    "processado": false
}

Do contrário, caso algum campo obrigatório não tenha sido informado, o response irá informar HttpStatusCode 400 BAD REQUEST e o seguinte erro:

Bloco de código

language	js

{
    "code": "WT-CONFIG-000032",
    "message": "Erro ao receber evento",
    "detailedMessage": "Campo Obrigatorio não pode ser nulo. Campo: X",
    "details": []
}

...

Páginas filhas

Versões comparadas

Versão antiga 82

Nova versão Atual

Chave