Para simplificar o processo de configuração e do TOTVS Connector Client, tanto para uma nova instalação, quanto para atualização de versão do produto e schemas, foram implementadas duas novas APIs, conforme descritas a seguir.
A API de Configuração automática pode ser utilizada para realizar a configuração da aplicação, após uma nova instalação, e até mesmo para configurar novos schemas. O processo consiste desde o sincronismo dos Schemas, criação do ProductConnection, vinculo do ProductConnection com um conjunto de SchemaDefinition, limpeza de registros antigos e deleção de triggers do TCC. Para mais informações consulte o manual do usuário.
Descrição: Configura a aplicação com base nos dados fornecidos.
URL: /api/v1/autoconfig
Método: POST
Headers:
Body:
Exemplo do corpo da requisição, que pode ser utilizada para primeira configuração ou incluir novas integrações.
{
"productConnection": {
"dataBaseType": "ORACLE12C",
"productName": "PIMSCS",
"url": "jdbc:oracle:thin:@127.0.0.1:1521:ORCL",
"username": "USERNAME",
"password": "PASSWORD"
},
"integrations": [
"meus-abastecimentos"
],
"forceSyncSchema": false,
"clearOldEvents": true,
"clearOthersProductConnectionSchema": false
} |
ou
Exemplo de corpo da requisição simplificada que pode ser utilizada quando há a necessidade de habilitar novas integrações e já há um ProductConnection previamente configurado.
{
"productConnection": {
"id": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51"
},
"integrations": [
"minha-borracharia"
]
} |
Os atributos informados no JSON são:
Respostas:
200 (OK): Configuração realizada com sucesso.
Retorna ProductConnection e os Schemas vinculados.
{
"productConnection": {
"id": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
"productName": "PIMSCS",
"productVersion": "12.1.2412",
"url": "jdbc:oracle:thin:@127.0.0.1:1521:ORCL",
"username": "USERNAME",
"dataBaseType": "ORACLE12C",
"enabled": true
},
"schemas": [
{
"id": "4038eb61-a927-4b02-9470-c6a7b90ac5f2",
"idProductConnection": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
"idSchemaDefinition": "583587b7-a6d3-4383-830c-b37fd84f20ae",
"versionSchemaDefinition": "12.1.2406.0001",
"nameSchemaDefinition": "Equipamento",
"enableStandalone": true,
"enablePublishRemote": false
},
{
"id": "8730f13f-50ac-4bd9-8576-bb6635a981d6",
"idProductConnection": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
"idSchemaDefinition": "22fa732b-c07d-4bb7-b409-f300b1840aca",
"versionSchemaDefinition": "12.1.27",
"nameSchemaDefinition": "CategoriaOperacional",
"enableStandalone": true,
"enablePublishRemote": false
},
{
"id": "b75499b4-96a0-412b-bd40-c34ed8b221ba",
"idProductConnection": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
"idSchemaDefinition": "0946d8b3-a0f3-49d7-bd97-a74af21eda7f",
"versionSchemaDefinition": "12.1.27",
"nameSchemaDefinition": "DisponibilidadeEquipamento",
"enableStandalone": true,
"enablePublishRemote": false
},
...
]
} |
400 (Bad Request): Falha ao validar as regras de negócio.
401 (Unauthorized): Falha de autenticação.
403 (Forbidden): Falha de autorização.
500 (Internal Server Error): Erro inesperado no sistema.
API destinada para realizar a atualização de todos os ProductConnections, incluindo a versão, com base na TCC_PRODUCT_METADATA, configurados e também a atualização dos Schemas Definition, vinculando sempre a ultima versão, menor ou igual a versão do produto.
Descrição: Atualiza todos os ProductConnections e SchemaDefinition da aplicação.
URL: /api/v1/autoconfig/updateAllupdateAllupdateAll
Método: POST
Headers:
Body: Não possui Body
Respostas:
200 (OK): Atualização realizada com sucesso.
Retorna Lista de ProductConnection e Schemas vinculados.
[
{
"productConnection": {
"id": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
"productName": "PIMSCS",
"productVersion": "12.1.2412",
"url": "jdbc:oracle:thin:@127.0.0.1:1521:ORCL",
"username": "USERNAME",
"dataBaseType": "ORACLE12C",
"enabled": true
},
"schemas": [
{
"id": "a618f297-234e-4580-b418-352967715cd5",
"idProductConnection": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
"idSchemaDefinition": "583587b7-a6d3-4383-830c-b37fd84f20ae",
"versionSchemaDefinition": "12.1.2406.0001",
"nameSchemaDefinition": "Equipamento",
"enableStandalone": true,
"enablePublishRemote": false
},
{
"id": "21999128-3e95-4572-a6c2-8a5df18b958c",
"idProductConnection": "37e7fefa-fb7e-441e-8d58-cd6c8daeaa51",
"idSchemaDefinition": "0946d8b3-a0f3-49d7-bd97-a74af21eda7f",
"versionSchemaDefinition": "12.1.27",
"nameSchemaDefinition": "DisponibilidadeEquipamento",
"enableStandalone": true,
"enablePublishRemote": false
},
...
]
},
...
] |
400 (Bad Request): Falha ao validar as regras de negócio.
401 (Unauthorized): Falha de autenticação.
403 (Forbidden): Falha de autorização.
500 (Internal Server Error): Erro inesperado no sistema.