API Reference

Credenciais

Levantamento e Cadastro de Credenciais por Distribuidora

O cadastro de credenciais depende diretamente da área logada das distribuidoras. Cada um exige um conjunto de informações e o sistema necessita que estejam todas de acordo para ativar corretamente o monitoramento.

Para facilitar o levantamento das credenciais necessárias para suas UCs e como é o preenchimento dos desses dados na rota criamos a Documentação dos acessos as Distribuidoras.

Nele separamos uma pagina para cada distribuidora onde informamos qual identificador único dela, qual é a área logada ou portal com sua url e um json modelo preenchido com um exemplo de envio correto das credenciais daquela distribuidora para que possa fazer o Levantamento de Credenciais .

Exemplo da documentação

I) Campo "Instalação": Código Único
O campo instalação é o identificador único do sistema. Uma vez cadastrado, ele não poder ser alterado e se for enviada uma atualização de cadastro, o sistema irá atualizar todas as informações a partir dele.
Exemplo do campo na fatura:

📘

A Amazonas utiliza o Código Único para identificar a UC em sua área logada, por isso chamamos ele "instalação" no nosso sistema.

II) Portal e Tipo de Acesso
O Portal da Distribuidora, comumente chamado também de agência virtual, é a área logada que da acesso aos PDFs e status das faturas de cada UC.
O Tipo de Acesso varia por distribuidora, mas geralmente são pedidos uma combinação dos dados de: Email, CNPJ, CPF e Senha.

a) Acesso via CNPJ ou CPF e Senha
Portal: https://agencia.amazonasenergia.com/

📘

A Amazonas possui apenas um portal (área logada) que solicita CNPJ ou CPF e Senha para acessar.

Para todas distribuidoras disponibilizamos o print e a url do portal que consideramos para monitoramento.

III) Json e Planilha Modelo

O Json Modelo serve como padrão de preenchimento dos dados para cadastro e atualização das Unidades Consumidoras via API.

Abaixo os modelos usados para distribuidora:

a) Acesso via CNPJ ou CPF e Senha

{
    "identificacao": "unidadade_pj",
    "nome": "unidade_manaus",
    "razaoSocial": "AM S.A.",
    "nomeFantasia": "AM",
    "inicioOperacaoRobo": "01/01/2023",
    "finalOperacaoRobo": "01/12/2023",
    "instalacao": "0736332-0",
    "distribuidora": "amazonas",       
    "cnpj": "44.387.255/0001-24",
    "login": "44.387.255/0001-24",
    "senha": "senha_123",
}

📘

Para cada portal disponível para monitoramento colocamos um json modelo como exemplo de como o cadastro deve ser enviado para API.