Range de Preços

O recurso é utilizado para consultar um range (preço mínimo, médio e máximo) de preços de sistemas fotovoltaicos a partir de alguns parâmetros.

Listar Filtros Disponíveis

GET

/filters

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

size number - Obrigatório
Porte do sistema.

module string - Opcional
Marca do módulo.

inverter string - Opcional
Marca do inversor.

info

Os parâmetros será enviado via query param. Exemplo de requisição:

https://api.greendex.info/filters?size=2

Resposta

Valores de Resposta

modules string list - Obrigatório
Lista de módulos disponíveis.

inverters string list - Obrigatório
Lista de inversores disponíveis.

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

{
  "modules": [
    "dah",
    "honor",
    "ja solar",
    "jinko",
    "sunova"
  ],
  "inverters": [
    "deye",
    "fronius",
    "ge",
    "growatt",
    "solis",
    "sungrow"
  ]
}

Calcular o Range de Preços do Sistema

POST

/prices

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

size number - Obrigatório
Porte do sistema.

uf string - Opcional *
Unidade Federativa do sistema.

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

cost_expectation number - Obrigatório
Expectativa de custo do sistema.

* uf ou cep deverão ser fornecidos.

Exemplo de corpo de requisição - uf

{
  "size": 5.5,
  "uf": "MG",
  "cost_expectation": 22500
}

Exemplo de corpo de requisição - cep

{
  "size": 5.5,
  "cep": "01153000",
  "cost_expectation": 22500
}

Resposta

Valores de Resposta

min_price number - Obrigatório
Preço mínimo calculado.

price_average number - Obrigatório
Preço médio calculado.

max_price number - Obrigatório
Preço máximo calculado.

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

{
  "protocol": "91d1af7f-4101-4248-9d09-824211cafa83",
  "min_price": 19078.2,
  "price_average": 22521.06,
  "max_price": 27711.89
}

Calcular o Range de Preços do Sistema com Filtro de Módulos e Inversores

POST

/filter-prices

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

size number - Obrigatório
Porte do sistema.

uf string - Opcional *
Unidade Federativa do sistema.

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

cost_expectation number - Opcional *
Expectativa de custo do sistema.

module_brand number - Opcional *
Marca do módulo.

inverter_brand number - Opcional *
Marca do inversor.

Exemplo de corpo de requisição - uf

{
  "size": 2,
  "uf": "MG",
  "cost_expectation": 500,
  "module_brand": "ja solar",
  "inverter_brand": "sungrow"
}

Exemplo de corpo de requisição - cep

{
  "size": 2,
  "cep": "01153000",
  "cost_expectation": 500,
  "module_brand": "ja solar",
  "inverter_brand": "sungrow"
}

Resposta

Valores de Resposta

kwp number - Obrigatório
Porte do sistema em kwp.

min_price number - Obrigatório
Preço mínimo calculado.

price_average number - Obrigatório
Preço médio calculado.

max_price number - Obrigatório
Preço máximo calculado.

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

filter_modules boolean Obrigatório
Identificador da aplicação de um filtro de módulo.

filter_inverters boolean Obrigatório
Identificador da aplicação de um filtro de inversor.

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": 7.2,
  "min_price": 20581.21,
  "price_average": 28163.94,
  "max_price": 40588.26,
  "protocol": "161001ca-26da-40ab-a604-a053dae2d8f5",
  "filter_modules": false,
  "filter_inverters": false
}