API para inserção, atualização, consulta e deleção do cadastro de Rotas EAI.
Descrição:
Efetua a inserção de um cadastro de Rotas EAI.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
product | Character | Marca na qual é integrada a mensagem.Ex: Protheus, RM, etc. | ||
sourceApplication | Character | Conteúdo recebido na tag SourceApplication. Cada EAI envia um conteúdo nesta tag, e neste campo deve ser completado com este valor. | ||
channel | Character | Indica se a rota se comunica com SOAP ou REST. (1-SOAP, 2-REST, 3-AMQP) |
SOAP
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
url | Character | Url de destino para esta rota. | ||
client | Character | Nome do client de Webservices que será utilizado. Este client deve estar compilado no repositório. | ||
method | Character | Método de consumo do WS. | ||
user | Character | Usuário de autenticação de Webservices. Somente utilizam autenticação para EAI. | ||
password | Character | Senha de autenticação de Webservices. Somente utilizam autenticação para EAI. |
Rest
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
url | Character | Url de destino para esta rota. | ||
user | Character | Usuário de autenticação de Webservices. Somente utilizam autenticação para EAI. | ||
password | Character | Senha de autenticação de Webservices. Somente utilizam autenticação para EAI. |
AMQP
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
url | Character | Url de destino para esta rota. | ||
port | Character | Porta de comunicação. | ||
user | Character | Usuário de autenticação de Webservices. Somente utilizam autenticação para EAI. | ||
password | Character | Senha de autenticação de Webservices. Somente utilizam autenticação para EAI. |
api/framework/v1/Apcfg021API |
Body
{ "product": "produto_08", "sourceApplication": "teste 2", "channel": "3", "soap": { "url": "teste.com.br", "client": "string", "method": "string", "user": "string", "password": "string" }, "rest": { "url": "string", "user": "string", "password": "string" }, "amqp": { "url": "string", "port": "string", "user": "string", "password": "string" } } |
Descrição:
Efetua a alteração de um cadastro de Rotas EAI. previamente cadastrado
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
product | Character | Marca na qual é integrada a mensagem.Ex: Protheus, RM, etc. | ||
sourceApplication | Character | Conteúdo recebido na tag SourceApplication. Cada EAI envia um conteúdo nesta tag, e neste campo deve ser completado com este valor. | ||
channel | Character | Indica se a rota se comunica com SOAP ou REST. (1-SOAP, 2-REST, 3-AMQP) |
SOAP
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
url | Character | Url de destino para esta rota. | ||
client | Character | Nome do client de Webservices que será utilizado. Este client deve estar compilado no repositório. | ||
method | Character | Método de consumo do WS. | ||
user | Character | Usuário de autenticação de Webservices. Somente utilizam autenticação para EAI. | ||
password | Character | Senha de autenticação de Webservices. Somente utilizam autenticação para EAI. |
Rest
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
url | Character | Url de destino para esta rota. | ||
user | Character | Usuário de autenticação de Webservices. Somente utilizam autenticação para EAI. | ||
password | Character | Senha de autenticação de Webservices. Somente utilizam autenticação para EAI. |
AMQP
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
url | Character | Url de destino para esta rota. | ||
port | Character | Porta de comunicação. | ||
user | Character | Usuário de autenticação de Webservices. Somente utilizam autenticação para EAI. | ||
password | Character | Senha de autenticação de Webservices. Somente utilizam autenticação para EAI. |
api/framework/v1/Apcfg021API |
Body
{ "product": "produto_08", "sourceApplication": "teste 2", "channel": "3", "soap": { "url": "teste.com.br", "client": "string", "method": "string", "user": "string", "password": "string" }, "rest": { "url": "string", "user": "string", "password": "string" }, "amqp": { "url": "string", "port": "string", "user": "string", "password": "string" } } |
delete
Descrição:
Efetua a exclusão de um cadastro De/Para EAI previamente cadastrado
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
product | Character | Marca na qual é integrada a mensagem.Ex: Protheus, RM, etc. | ||
sourceApplication | Character | Conteúdo recebido na tag SourceApplication. Cada EAI envia um conteúdo nesta tag, e neste campo deve ser completado com este valor. |
api/framework/v1/Apcfg021API |
Body
{ "product": "produto_08", "sourceApplication": "teste 2" } |
get
Descrição:
Pesquisa de todos as rotas.
api/framework/v1/Apcfg021API |
Descrição:
Pesquisa de uma rota específica.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor padrão |
---|---|---|---|---|
product | Character | Marca na qual é integrada a mensagem.Ex: Protheus, RM, etc. | ||
sourceApplication | Character | Conteúdo recebido na tag SourceApplication. Cada EAI envia um conteúdo nesta tag, e neste campo deve ser completado com este valor. |
api/framework/v1/Apcfg021API/GetRouteEaiAPI |
Body
{ "product": "produto_04", "sourceApplication": "teste 2" } |