API para inserção, atualização, consulta e deleção do cadastro de adapter EAI.
Descrição:
Efetua a inserção de um adapter EAI
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
routine | Character | Nome do programa que contém a função "ModelDef". O sistema irá realizar a integração da rotina representada por este programa com o TOTVS ESB. | ||
model | Character | Informe o ID do model para mensagens MVC Protheus e o nome da mensagem para Mensageria Padrão | ||
description | Character | Informe uma breve descrição da rotina para documentação e posterior consulta. | ||
sender | Character | Informe se a rotina esta habilitada para transacionar todas as modificações realizadas pela rotina com o TOTVS ESB. (1-Sim, 2-Não) | ||
receive | Character | Informe se a rotina esta habilitada para transacionar todas as modificações realizadas nos sistemas legados e recebidas pelo TOTVS ESB. (1-Sim, 2-Não) | ||
method | Character | Informe o método de comunicação com o TOTVS ESB. (1-Sincrono, 2-Assincrono) | ||
operation | Character | Tipo da operação. (1-Todas, 2-Atualização, 3-Exclusão) | ||
condition | Character | Expressao de filtro para envio | ||
loadReceive | Character | Informe o nome da rotina de complemento na recepção da mensagem. | ||
loadSend | Character | Informane o nome da rotina de complemento no envio da mensagem | ||
channel | Character | Informe o canal que recebera o envio das mensagens. Este canal pode ser o ESB ou outro EAI. (1-ESB, 2-EAI-SOAP, 3-EAI - PAD.APP) | ||
uniqueMessage | Character | Informe se esta é uma mensagem do tipo MENSAGEM UNICA ou não. (1-Sim, 2-Não) | ||
xsd | Character | Informe o caminho do arquivo XSD de validacao do XML. | ||
executionBranch | Character | Informe a filial de execucao da mensagem. Se for deixado em branco a mensagem podera ser executada em todas as filiais | ||
xmlManipulation | Character | XML de manipulação | ||
sendVersion | Character | Versão de Envio | ||
alias | Character | Caso queira informar para a outro sistema como está sua configuração de compartilhamento de tabelas(Empresa, Unidade de Negócio e Filial), informe aqui o Alias principal da rotina. | ||
format | Character | Formato. (XML, JSON) | ||
saveLog | Character | Indica se esta mensagem tera registro na tabela de logs, (1-Sim, 2-Não) |
Routes - Roteamento de mensagens
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
product | Character | Marca para a qual a mensagem é integrada. Ex: Protheus, RM, etc. | ||
sourceApplication | Character | Conteúdo recebido na tag SourceApplication. Cada EAI envia um conteúdo nesta tag, e este campo deve ser preenchido com este valor. | ||
sender | Character | Indica se esta rota está disponível para envio das mensagens e geração de ResponseMessage (1=sim) ou somente para a geração da ResponseMessage (2=não). | ||
condition | Character | Condição |
Painel | ||
---|---|---|
| ||
/api/framework/v1/Apcfg020API |
Body
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "routine": "MATA030", "model": "CUSTOMERVENDOR", "description": "Inclusão de cliente", "sender": "1", "receive": "2", "method": "1", "operation": "3", "condition": "", "loadReceive": "", "loadSend": "", "channel": "3", "uniqueMessage": "2", "xsd": "", "executionBranch": "0102", "xmlManipulation": "", "sendVersion": "2.001", "alias": "SA1", "format": "JSON", "saveLog": "1", "routes":[ { "product": "produto_01", "sourceApplication": "teste", "sender": "2", "condition": "TESTE" } ] } |
Descrição:
Efetua a alteração de um adapter previamente cadastrado
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
routine | Character | Nome do programa que contém a função "ModelDef". O sistema irá realizar a integração da rotina representada por este programa com o TOTVS ESB. | ||
model | Character | Informe o ID do model para mensagens MVC Protheus e o nome da mensagem para Mensageria Padrão | ||
description | Character | Informe uma breve descrição da rotina para documentação e posterior consulta. | ||
sender | Character | Informe se a rotina esta habilitada para transacionar todas as modificações realizadas pela rotina com o TOTVS ESB. (1-Sim, 2-Não) | ||
receive | Character | Informe se a rotina esta habilitada para transacionar todas as modificações realizadas nos sistemas legados e recebidas pelo TOTVS ESB. (1-Sim, 2-Não) | ||
method | Character | Informe o método de comunicação com o TOTVS ESB. (1-Sincrono, 2-Assincrono) | ||
operation | Character | Tipo da operação. (1-Todas, 2-Atualização, 3-Exclusão) | ||
condition | Character | Expressao de filtro para envio | ||
loadReceive | Character | Informe o nome da rotina de complemento na recepção da mensagem. | ||
loadSend | Character | Informane o nome da rotina de complemento no envio da mensagem | ||
channel | Character | Informe o canal que recebera o envio das mensagens. Este canal pode ser o ESB ou outro EAI. (1-ESB, 2-EAI-SOAP, 3-EAI - PAD.APP) | ||
uniqueMessage | Character | Informe se esta é uma mensagem do tipo MENSAGEM UNICA ou não. (1-Sim, 2-Não) | ||
xsd | Character | Informe o caminho do arquivo XSD de validacao do XML. | ||
executionBranch | Character | Informe a filial de execucao da mensagem. Se for deixado em branco a mensagem podera ser executada em todas as filiais | ||
xmlManipulation | Character | XML de manipulação | ||
sendVersion | Character | Versão de Envio | ||
alias | Character | Caso queira informar para a outro sistema como está sua configuração de compartilhamento de tabelas(Empresa, Unidade de Negócio e Filial), informe aqui o Alias principal da rotina. | ||
format | Character | Formato. (XML, JSON) | ||
saveLog | Character | Indica se esta mensagem tera registro na tabela de logs, (1-Sim, 2-Não) |
Routes - Roteamento de mensagens
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
product | Character | Marca para a qual a mensagem é integrada. Ex: Protheus, RM, etc. | ||
sourceApplication | Character | Conteúdo recebido na tag SourceApplication. Cada EAI envia um conteúdo nesta tag, e este campo deve ser preenchido com este valor. | ||
sender | Character | Indica se esta rota está disponível para envio das mensagens e geração de ResponseMessage (1=sim) ou somente para a geração da ResponseMessage (2=não). | ||
condition | Character | Condição |
Painel | ||
---|---|---|
| ||
/api/framework/v1/Apcfg020API |
Body
Bloco de código | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "routine": "MATA030", "model": "CUSTOMERVENDOR", "description": "Alterado", "sender": "2", "receive": "2", "method": "2", "operation": "1", "condition": "", "loadReceive": "MATA030", "loadSend": "MATA030", "channel": "2", "uniqueMessage": "1", "xsd": "", "executionBranch": "0102", "xmlManipulation": "", "sendVersion": "2.005", "alias": "SA1", "format": "", "saveLog": "1", "routes":[ { "product": "produto_01", "sourceApplication": "teste", "sender": "2", "condition": "" }, { "product": "TESTE1", "sourceApplication": "TESTE", "sender": "2", "condition": "" } ] } |
A propriedade value do JSON é aberta e pode ser enviado qualquer valor, até mesmo um JSON, esse valor será convertido para character do ADVPL via cValToChar, portanto é necessário apenas se atentar a qual conversão a cValToChar pode fazer com o valor recebido.
Descrição:
Efetua a exclusão de um Profile previamente cadastrado
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
routine | Character | Nome do programa que contém a função "ModelDef". O sistema irá realizar a integração da rotina representada por este programa com o TOTVS ESB. | ||
model | Character | Informe o ID do model para mensagens MVC Protheus e o nome da mensagem para Mensageria Padrão | ||
executionBranch | Character | Informe a filial de execucao da mensagem. Se for deixado em branco a mensagem podera ser executada em todas as filiais |
Painel | ||
---|---|---|
| ||
api/framework/v1/Apcfg020API |
Bloco de código | ||
---|---|---|
| ||
{ "routine": "MATA030", "model": "CUSTOMERVENDOR", "executionBranch": "" } |
Descrição:
Pesquisa de todos os cadastros de adapter EAI
Painel | ||
---|---|---|
| ||
api/framework/v1/Apcfg020API |
Descrição:
Pesquisa das rotas de um cadastro específico de adapter EAI
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
routine | Character | Nome do programa que contém a função "ModelDef". O sistema irá realizar a integração da rotina representada por este programa com o TOTVS ESB. | ||
model | Character | Informe o ID do model para mensagens MVC Protheus e o nome da mensagem para Mensageria Padrão | ||
executionBranch | Character | Informe a filial de execucao da mensagem. Se for deixado em branco a mensagem podera ser executada em todas as filiais |
Painel | ||
---|---|---|
| ||
api/framework/v1/Apcfg020API/GetRoutesAdapterEAI |
Bloco de código | ||
---|---|---|
| ||
{ "routine": "MATA030", "model": "CUSTOMERVENDOR", "executionBranch": "" } |
Descrição:
Pesquisa de um cadastro específico de adapter EAI
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
routine | Character | Nome do programa que contém a função "ModelDef". O sistema irá realizar a integração da rotina representada por este programa com o TOTVS ESB. | ||
model | Character | Informe o ID do model para mensagens MVC Protheus e o nome da mensagem para Mensageria Padrão | ||
executionBranch | Character | Informe a filial de execucao da mensagem. Se for deixado em branco a mensagem podera ser executada em todas as filiais |
Painel | ||
---|---|---|
| ||
api/framework/v1/Apcfg020API/GetUniqueAdapterEAI |
Bloco de código | ||
---|---|---|
| ||
{ "routine": "MATA030", "model": "CUSTOMERVENDOR", "executionBranch": "" } |