Histórico da Página
Neste documento, são demonstradas as formas de utilização dos endpoints de configuração de integrações entre produtos TOTVS, padrão REST/JSON.
...
- Order contém a definição de como a lista deve ser ordenada. Apresenta o nome de uma, ou mais, propriedades (Ex: name, description...). Será ordenação decrescente se o símbolo de negativo
for encontrado à frente da propriedade (Ex: Name-name). Caso contrário, subentende-se crescente.
- Page deve ser um valor numérico (maior que zero) representando a página solicitada
- PageSize deve ser um valor numérico (maior que zero) representando o total de registros retornados na consulta
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationId": "b0d4bdb3-5d56-53e9-b96d-10a5da6dfaf7", "name": "TINPROT", "description": "TOTVS Incorporação x BackOffice Protheus", "routes": [{ "transactionsFlow": [{ "transactionId": "COSTCENTER", "version": "2.000", "direction": "both" }, { "transactionId": "CUSTOMERVENDOR", "version": "2.002", "direction": "both" }, { "transactionId": "UPDATECONTRACTSTATUSPARCEL", "version": "1.000", "direction": "receive" }], "applicationPair": { "sourceApplication": { "appId": "SOURCEAPP@PRODUCT", "name": "NAME", "description": "DESCRIPTION", "sourceApplication": "SOURCEAPP", "productCode": "PRODUCT", "productVersion": null, "msgValidation": null, "portName": null, "wsdlUrl": "", "user": "user", "password": "password", "monitorUrl": "http://monitorUrl", "enableRest": 1, "restEndpointUrl": "http://http://restEndpointUrl", "paramEndpoints": { "general": { "metadata": "/params/1.0/metadata", "values": "/params/1.0/value" }, "transaction": { "metadata": "/transactionParams", "values": "/transactionValues" } } }, "destinationApplication": { "appId": "SOURCEAPP@PRODUCT", "name": "NAME", "description": "DESCRIPTION", "sourceApplication": "SOURCEAPP", "productCode": "PRODUCT", "productVersionwsdlUrl": null"", "msgValidationuser": null"user", "portNamepassword": null"password", "wsdlUrl": "", "user": "user", "password": "password", "monitorUrl": "http://monitorUrl", "enableRest": 1, "restEndpointUrl": "http://http://restEndpointUrl", "paramEndpoints": { "general": { "metadata": "/params/1.0/metadata", "values": "/params/1.0/value" }, "transaction": { "metadata": "/transactionParams", "values": "/transactionValues" } } } } }] } |
Criar uma integração
PUT /totvseai/configurator/v1/integrations/{integrationId}
...
Bloco de código | ||||
---|---|---|---|---|
| ||||
{ "integrationId": "b0d4bdb3-5d56-53e9-b96d-10a5da6dfaf7", "name": "TINPROT", "description": "TOTVS Incorporação x BackOffice Protheus", "routes": [{ "transactionsFlow": [{ "transactionId": "COSTCENTER", "version": "2.000", "direction": "both" }, { "transactionId": "CUSTOMERVENDOR", "version": "2.002", "direction": "both" }, { "transactionId": "UPDATECONTRACTSTATUSPARCEL", "version": "1.000", "direction": "receive" }], "applicationPair": { "sourceApplication": { "appId": "SOURCEAPP@PRODUCT", "name": "NAME", "description": "DESCRIPTION", "sourceApplication": "SOURCEAPP", "productCode": "PRODUCT", "productVersionwsdlUrl": null"", "msgValidationuser": null"user", "portNamepassword": null, "wsdlUrl": "", "user": "user", "password": "password", "monitorUrl": "http://monitorUrl", "enableRest": 1, "restEndpointUrl": "http://http://restEndpointUrl", "paramEndpoints": { "general": { "metadata": "/params/1.0/metadata", "values": "/params/1.0/value" }, "transaction": { "metadata": "/transactionParams", "values": "/transactionValues" } } }, "destinationApplication": { "appId": "SOURCEAPP@PRODUCT", "name": "NAME", "description": "DESCRIPTION", "sourceApplication": "SOURCEAPP", "productCode": "PRODUCT", "productVersionwsdlUrl": null"", "msgValidationuser": null"user", "portNamepassword": null, "wsdlUrl": "", "user": "user", "password": "password", "monitorUrl": "http://monitorUrl", "enableRest": 1, "restEndpointUrl": "http://http://restEndpointUrl", "paramEndpoints": { "general": { "metadata": "/params/1.0/metadata", "values": "/params/1.0/value" }, "transaction": { "metadata": "/transactionParams", "values": "/transactionValues" } } } } }] } |
...
Aviso | ||
---|---|---|
| ||
Todas as operações realizadas acima serão aplicadas apenas no produto apontado, podendo criar integrações "quebradas". Por exemplo: ao fazer um PUT de uma integração "Protheus/RM" no endpoint do Protheus, apenas o Protheus terá recebido a integração. O RM continua desconfigurado. Portanto, é recomendável que esses serviços não sejam acionados diretamente, e sim através da interface UI do configurador, que possui lógica adicional para garantir a integridade das configurações em todos os produtos envolvidos. |
Âncora | ||||
---|---|---|---|---|
|
Segue abaixo uma lista com os possíveis códigos de erro e seus siginificados:
- 400 (Bad Request): Erro relacionado ao pedido feito pelo usuário. Pode ter sido causado por formato inválido do JSON enviado no body da requisição HTTP ou alguma validação da regra de negócio.
- 401 (Unauthorized): Login/senha inválidos
- 403 (Forbidden): Falta de permissão de acesso
- 404 (Not Found): O recurso solicitado não existe (Verificar o verbo rest e URL)
- 500 (Internal Server Error): Erro não previsto na execução de alguma tarefa no serviço, contatar o suporte.