Documentação da API DistriSync

Integre dados normalizados de unidades consumidoras, faturas e PDFs com exemplos executáveis, schemas completos e correções objetivas para cada falha.

Nesta página

Modelo da API
Primeira requisição
Próximos passos

O modelo da API

A integração usa conexões e trabalhos. Uma conexão representa o acesso autorizado a uma distribuidora. Um trabalho representa uma operação solicitada, como descobrir UCs ou sincronizar faturas.

Se você já possui uma fatura CELESC ou COPEL, o leitor de PDF oferece um caminho síncrono: envie o documento e receba pdf_data sem criar conexão ou trabalho.

1
Autentique cada chamada
Envie sua chave em X-API-Key.
Detalhes
2
Autorize uma conexão
Envie a distribuidora e as credenciais do titular.
Detalhes
3
Crie um trabalho
Escolha o tipo e informe os seletores exigidos.
Detalhes
4
Acompanhe até um estado terminal
Continue consultando enquanto estiver queued, running ou cancelling.
Detalhes
5
Use o resultado
Leia result.items, trate error e baixe arquivos pela URL retornada.
Detalhes

Sua primeira requisição

Use a URL base fornecida para o seu ambiente. O exemplo cria uma conexão CELESC; para COPEL, use CPF ou CNPJ válido, somente com dígitos.

POST/api/v1/connections/authorize

curl -X POST "<URL_BASE>/connections/authorize" \
  -H "X-API-Key: <SUA_CHAVE>" \
  -H "Content-Type: application/json" \
  -d '{
    "dist": "CELESC",
    "username": "integracao@exemplo.com.br",
    "password": "<SENHA_DA_DISTRIBUIDORA>"
  }'

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

Continue pela sua tarefa

Implemente o fluxo completo com cURL, JavaScript e Python.Primeira integração Consulte os campos, enums e dados de PDF específicos da COPEL e da CELESC.Schemas por distribuidora