Obter kits disponíveis

Obtem kits disponíveis de acordo com filtros

curl --request POST \
  --url https://backend-pied-prod.piedadmin.com.br/api/v2/kits \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "power": 123,
  "ibgeCode": "<string>",
  "structureType": "<string>",
  "structureName": "<string>",
  "inverterConnectionType": "<string>",
  "inverterVoltage": 123,
  "inverterBrand": "<string>"
}
'

import requests

url = "https://backend-pied-prod.piedadmin.com.br/api/v2/kits"

payload = {
    "power": 123,
    "ibgeCode": "<string>",
    "structureType": "<string>",
    "structureName": "<string>",
    "inverterConnectionType": "<string>",
    "inverterVoltage": 123,
    "inverterBrand": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    power: 123,
    ibgeCode: '<string>',
    structureType: '<string>',
    structureName: '<string>',
    inverterConnectionType: '<string>',
    inverterVoltage: 123,
    inverterBrand: '<string>'
  })
};

fetch('https://backend-pied-prod.piedadmin.com.br/api/v2/kits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://backend-pied-prod.piedadmin.com.br/api/v2/kits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'power' => 123,
    'ibgeCode' => '<string>',
    'structureType' => '<string>',
    'structureName' => '<string>',
    'inverterConnectionType' => '<string>',
    'inverterVoltage' => 123,
    'inverterBrand' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://backend-pied-prod.piedadmin.com.br/api/v2/kits"

	payload := strings.NewReader("{\n  \"power\": 123,\n  \"ibgeCode\": \"<string>\",\n  \"structureType\": \"<string>\",\n  \"structureName\": \"<string>\",\n  \"inverterConnectionType\": \"<string>\",\n  \"inverterVoltage\": 123,\n  \"inverterBrand\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://backend-pied-prod.piedadmin.com.br/api/v2/kits")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"power\": 123,\n  \"ibgeCode\": \"<string>\",\n  \"structureType\": \"<string>\",\n  \"structureName\": \"<string>\",\n  \"inverterConnectionType\": \"<string>\",\n  \"inverterVoltage\": 123,\n  \"inverterBrand\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://backend-pied-prod.piedadmin.com.br/api/v2/kits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"power\": 123,\n  \"ibgeCode\": \"<string>\",\n  \"structureType\": \"<string>\",\n  \"structureName\": \"<string>\",\n  \"inverterConnectionType\": \"<string>\",\n  \"inverterVoltage\": 123,\n  \"inverterBrand\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "metadata": {
    "total": 123
  },
  "data": [
    {
      "name": "<string>",
      "power": 123,
      "price": 123,
      "moduleBrand": "<string>",
      "inverterBrand": "<string>",
      "voltage": "<string>",
      "structure": {
        "name": "<string>",
        "type": "nenhuma"
      },
      "products": [
        {
          "productCode": "<string>",
          "name": "<string>",
          "brand": "<string>",
          "model": "<string>",
          "amount": 123,
          "price": 123,
          "weight": 123,
          "width": 123,
          "height": 123,
          "depth": 123,
          "type": "module",
          "attributes": {
            "potencia_nominal_de_saida_KW": 123
          }
        }
      ]
    }
  ]
}

"<unknown>"

POST

kits

Obtem kits disponíveis de acordo com filtros

curl --request POST \
  --url https://backend-pied-prod.piedadmin.com.br/api/v2/kits \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "power": 123,
  "ibgeCode": "<string>",
  "structureType": "<string>",
  "structureName": "<string>",
  "inverterConnectionType": "<string>",
  "inverterVoltage": 123,
  "inverterBrand": "<string>"
}
'

import requests

url = "https://backend-pied-prod.piedadmin.com.br/api/v2/kits"

payload = {
    "power": 123,
    "ibgeCode": "<string>",
    "structureType": "<string>",
    "structureName": "<string>",
    "inverterConnectionType": "<string>",
    "inverterVoltage": 123,
    "inverterBrand": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    power: 123,
    ibgeCode: '<string>',
    structureType: '<string>',
    structureName: '<string>',
    inverterConnectionType: '<string>',
    inverterVoltage: 123,
    inverterBrand: '<string>'
  })
};

fetch('https://backend-pied-prod.piedadmin.com.br/api/v2/kits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://backend-pied-prod.piedadmin.com.br/api/v2/kits",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'power' => 123,
    'ibgeCode' => '<string>',
    'structureType' => '<string>',
    'structureName' => '<string>',
    'inverterConnectionType' => '<string>',
    'inverterVoltage' => 123,
    'inverterBrand' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://backend-pied-prod.piedadmin.com.br/api/v2/kits"

	payload := strings.NewReader("{\n  \"power\": 123,\n  \"ibgeCode\": \"<string>\",\n  \"structureType\": \"<string>\",\n  \"structureName\": \"<string>\",\n  \"inverterConnectionType\": \"<string>\",\n  \"inverterVoltage\": 123,\n  \"inverterBrand\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://backend-pied-prod.piedadmin.com.br/api/v2/kits")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"power\": 123,\n  \"ibgeCode\": \"<string>\",\n  \"structureType\": \"<string>\",\n  \"structureName\": \"<string>\",\n  \"inverterConnectionType\": \"<string>\",\n  \"inverterVoltage\": 123,\n  \"inverterBrand\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://backend-pied-prod.piedadmin.com.br/api/v2/kits")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"power\": 123,\n  \"ibgeCode\": \"<string>\",\n  \"structureType\": \"<string>\",\n  \"structureName\": \"<string>\",\n  \"inverterConnectionType\": \"<string>\",\n  \"inverterVoltage\": 123,\n  \"inverterBrand\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "metadata": {
    "total": 123
  },
  "data": [
    {
      "name": "<string>",
      "power": 123,
      "price": 123,
      "moduleBrand": "<string>",
      "inverterBrand": "<string>",
      "voltage": "<string>",
      "structure": {
        "name": "<string>",
        "type": "nenhuma"
      },
      "products": [
        {
          "productCode": "<string>",
          "name": "<string>",
          "brand": "<string>",
          "model": "<string>",
          "amount": 123,
          "price": 123,
          "weight": 123,
          "width": 123,
          "height": 123,
          "depth": 123,
          "type": "module",
          "attributes": {
            "potencia_nominal_de_saida_KW": 123
          }
        }
      ]
    }
  ]
}

"<unknown>"

Autenticação

OAuth 2.0 (Client Credentials): Obtenha um token via POST /oauth/token com suas credenciais de cliente e use-o como Bearer Token.

curl -X POST https://backend-pied-prod.piedadmin.com.br/api/oauth/token \
  -H "Content-Type: application/json" \
  -d '{
    "grant_type": "client_credentials",
    "client_id": "SEU_CLIENT_ID",
    "client_secret": "SEU_CLIENT_SECRET"
  }'

Sobre este endpoint

Retorna a lista de kits fotovoltaicos disponíveis com base nos parâmetros informados. Use o endpoint Obter filtros disponíveis para descobrir quais valores são aceitos em cada campo antes de montar a requisição.

Authorizations

Authorization

string

header

required

Body

application/json

power

number

required

Potência em kWp. A API retornará a lista com os kits disponíveis mais próximos desta potência.

ibgeCode

string

required

Código IBGE da Cidade de Entrega. Utilizado para calcular disponibilidade e frete.

structureType

string

required

Tipo de estrutura de fixação. Use as opções disponíveis no retorno de "structures" do endpoint "Obter filtros disponíveis" (onde label é o structureType). Caso não deseje estrutura, envie "nenhuma".

structureName

string

required

Nome específico da estrutura de fixação. A API retornará a lista de kits disponíveis para essa estrutura. Opções disponíveis no retorno de "structures" do endpoint "Obter filtros disponíveis". Onde value é structureName.

inverterConnectionType

string

required

Tipo de conexão. A API retornará a lista de kits disponíveis com inversores neste tipo de conexão. Opções disponíveis no retorno de "voltages" do endpoint "Obter filtros disponíveis". Onde tipo_ligacao é o inverterConnectionType.

inverterVoltage

integer

required

Tensão de saída. A API retornará a lista de kits disponíveis com inversores nesta tensão de saída. Opções disponíveis no retorno de "voltages" do endpoint "Obter filtros disponíveis". Onde tensao_nominal_de_saida_V é o inverterVoltage.

inverterBrand

string

Marca do Inversor. A API retornará a lista de kits disponíveis aplicando um filtro por essa marca de inversor. Opções disponíveis no retorno de "inverterBrands" do endpoint "Obter filtros disponíveis". Onde value é o inverterBrand.

inverterType

enum<string>

Tipo de Inversor. A API retornará a lista de kits disponíveis aplicando um filtro por esse tipo de inversor. Opções disponíveis no retorno de "inverterType" do endpoint "Obter filtros disponíveis". Onde value é o inverterType.

Available options:

string,

hibrido,

micro,

solaredge

requestor

object

Informações da empresa realizando cotação.

Show child attributes

Response

success

boolean

metadata

object

Show child attributes

data

object[]

Show child attributes

Visão Geral

Requests

Empresas

Equipamentos

Colaboradores

Pagamentos

Campos Customizados

Kits

Obter kits disponíveis

Autenticação

Sobre este endpoint

Authorizations

Body

Response

​Autenticação

​Sobre este endpoint

Authorizations

Body

Response

Autenticação

Sobre este endpoint