Conexões

Registre credenciais de distribuidora, liste conexões do cliente, consulte UCs conhecidas e revogue acessos.

Nesta página

Autorizar
Listar
Listar UCs
Revogar

Autorizar ou reautorizar

POST/api/v1/connections/authorize

{
  "dist": "CELESC",
  "username": "integracao@exemplo.com.br",
  "password": "<SENHA_DA_DISTRIBUIDORA>"
}

Campo	Tipo	Regra
`dist`	string	`CELESC` ou `COPEL`.
`username`	string	CELESC: e-mail válido. COPEL: CPF/CNPJ válido, somente dígitos.
`password`	string	Senha do portal da distribuidora.
`connectionId`	string \| null	Envie para atualizar a conexão existente sem trocar seu identificador.

{
  "schemaVersion": "3.0",
  "connectionId": "conn_exemplo_123",
  "dist": "CELESC",
  "installation": null,
  "contractAccount": null,
  "status": "active"
}

Listar conexões

GET/api/v1/connections

Retorna schemaVersion, count e connections[]. Cada item contém connectionId, dist, installation, contractAccount e status.

Listar UCs conhecidas

GET/api/v1/connections/{connectionId}/ucs

Retorna a lista disponível para a conexão. Para atualizá-la a partir da distribuidora, crie um trabalho uc_discovery.

{
  "schemaVersion": "3.0",
  "count": 1,
  "ucs": [
    {
      "schemaVersion": "3.0",
      "dist": "CELESC",
      "consumerUnit": {
        "installationId": "154026601110",
        "legacyInstallationId": "24870235",
        "contractAccount": "24870235"
      },
      "customer": {
        "name": "CLIENTE EXEMPLO"
      },
      "serviceAddress": {
        "formatted": "RUA EXEMPLO, 100, CENTRO, GASPAR, SC, 89110-000",
        "street": "RUA EXEMPLO, 100",
        "neighborhood": "CENTRO",
        "city": "Gaspar",
        "state": "SC",
        "postalCode": "89110-000"
      },
      "lastUpdated": "2026-08-24T14:00:00Z"
    }
  ]
}

Campo	Tipo	Descrição
`schemaVersion`	string	Versão do recurso: 3.0.
`dist`	string	Código da distribuidora.
`consumerUnit.installationId`	string	Identificador atual da UC.
`consumerUnit.legacyInstallationId`	string \| null	Identificador anterior.
`consumerUnit.contractAccount`	string \| null	Conta contrato.
`customer.name`	string \| null	Nome retornado para ajudar a identificar a UC.
`serviceAddress.formatted`	string \| null	Endereço completo formatado.
`serviceAddress.street`	string \| null	Logradouro e número.
`serviceAddress.neighborhood`	string \| null	Bairro.
`serviceAddress.city`	string \| null	Município.
`serviceAddress.state`	string \| null	UF.
`serviceAddress.postalCode`	string \| null	CEP formatado.
`lastUpdated`	datetime	Última atualização em ISO 8601 com offset.

Revogar uma conexão

DELETE/api/v1/connections/{connectionId}

{
  "revoked": true
}

Depois de revogada, a conexão não pode ser usada em novos trabalhos. Uma conexão inexistente ou já removida pode retornar revoked: false.