Dimensionador

Recurso utilizado para consultar a dimensão de um sistema fotovoltaico a partir de alguns parâmetros.

Calcular o Porte do Sistema

POST

/sizer

Cabeçalho

É necessário comprovar autorização com o access_token para realizar essa operação.

Authorization: Bearer access_token

accept: application/json

Exemplo de headers

{
  "Authorization": "Bearer your_jwt_access_token",
  "accept": "application/json"
}

Parâmetros

uf string Opcional *
Unidade Federativa do sistema.

municipalitie string Opcional *
Município do sistema.

cep string Opcional *
Código de Endereçamento Postal - CEP.

client_type string Obrigatório
Tipo do cliente que por padrão é residencial.

connection_type string Obrigatório
Tipo de conexão do cliente que por padrão é bifasica.

average_bill_value number Obrigatório
Média do valor (R$) da conta de energia dos últimos 12 meses.

* uf e municipalitie ou cep ou apenas uf deverão ser fornecidos.

Exemplo de corpo de requisição - cidade e estado

{
  "uf": "MG",
  "municipalitie": "Itajubá",
  "client_type": "residencial",
  "connection_type": "bifasica",
  "average_bill_value": 500
}

Exemplo de corpo de requisição - cep

{
  "cep": "01153000",
  "client_type": "residencial",
  "connection_type": "bifasica",
  "average_bill_value": 500
}

Resposta

Valores de Resposta

kwp number Obrigatório
Porte do sistema em kwp.

protocol string Obrigatório
Identificador único da requisição.

Código de Status de Resposta

Código	Descrição
200	Sucesso
400	Erro de dados enviados pelo cliente
404	Erro ao encontrar dado utilizado no cálculo do porte/preço dos kits (exemplo: cep, kits, cidade, estado, tarifa e etc)
500	Erro do servidor

Exemplo de resposta

{
  "kwp": 5.5,
  "protocol": "ed5bb654-9b6d-49c5-bb40-a544e5d70678"
}

Listar Unidades Federetivas

GET

/uf

Cabeçalho

É necessário comprovar autorização com o access_token para realizar essa operação.

Authorization: Bearer access_token

accept: application/json

Exemplo de headers

{
  "Authorization": "Bearer your_jwt_access_token",
  "accept": "application/json"
}

Parâmetros

Sem parâmetros.

Resposta

Valores de Resposta

uf string list Obrigatório
Lista de unidades federativas.

Código de Status de Resposta

Código	Descrição
200	Sucesso
400	Erro de dados enviados pelo cliente
404	Erro ao encontrar dado utilizado no cálculo do porte/preço dos kits (exemplo: cep, kits, cidade, estado, tarifa e etc)
500	Erro do servidor

Exemplo de resposta

[
  "AC",
  "AL",
  "AM",
  "AP",
  "BA",
  "CE",
  "DF",
  "ES",
  "GO",
  "MA",
  "MG",
  "MS",
  "MT",
  "PA",
  "PB",
  "PE",
  "PI",
  "PR",
  "RJ",
  "RN",
  "RO",
  "RR",
  "RS",
  "SC",
  "SE",
  "SP",
  "TO"
]

Listar Cidades Disponíveis

GET

/cities

Cabeçalho

É necessário comprovar autorização com o access_token para realizar essa operação.

Authorization: Bearer access_token

accept: application/json

Exemplo de headers

{
  "Authorization": "Bearer your_jwt_access_token",
  "accept": "application/json"
}

Parâmetros

uf string Obrigatório
Lista de unidades federativas.

info

O parâmetro uf será enviado via query param. Exemplo de requisição:

https://api.greendex.info/cities?uf=mg

Resposta

Valores de Resposta

uf string list Obrigatório
Lista de unidades federativas.

Código de Status de Resposta

Código	Descrição
200	Sucesso
400	Erro de dados enviados pelo cliente
404	Erro ao encontrar dado utilizado no cálculo do porte/preço dos kits (exemplo: cep, kits, cidade, estado, tarifa e etc)
500	Erro do servidor

Exemplo de resposta

[
  "Acrelândia",
  "Assis Brasil",
  "Brasiléia",
  "Bujari",
  "Capixaba",
  "Cruzeiro do Sul",
  "Epitaciolândia",
  "Feijó",
  "Jordão",
  "Mâncio Lima",
  "Manoel Urbano",
  "Marechal Thaumaturgo",
  "Plácido de Castro",
  "Porto Acre",
  "Porto Walter",
  "Rio Branco",
  "Rodrigues Alves",
  "Santa Rosa do Purus",
  "Senador Guiomard",
  "Sena Madureira",
  "Tarauacá",
  "Xapuri"
]