Skip to main content

​
1. Obtenha seu Token de Acesso

Para usar a API PIED, você precisa de um token Bearer. Gere o token diretamente em sua plataforma. Gerar chave API
Mantenha seu token seguro e nunca o compartilhe publicamente. Use variáveis de ambiente em produção.

​
2. Faça sua Primeira Requisição

Vamos buscar a lista de orçamentos: 
curl -X GET "https://backend-pied-prod.piedadmin.com.br/api/v2/requests/budget/1/10" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI" \
  -H "Content-Type: application/json"

​
Resposta Esperada

Sobre o tamanho da resposta: A resposta real pode ser significativamente maior, contendo dezenas de campos adicionais por item, incluindo detalhes completos de equipamentos, informações de contato, dados técnicos, histórico de alterações, e muito mais. O exemplo abaixo mostra apenas os campos principais para simplicidade.
{
  "data": [
    {
      "id": "123456",
      "name": "Orçamento Solar Residencial",
      "code": "200000001",
      "kind": "Kit Personalizado",
      "totalPower": 5.5,
      "budgetCreated": "2024-01-15T10:30:00.000Z",
      "dealStatus": "Em Análise",
      "originalValue": 25000,
      "finalValue": 22500,
      // ... muitos outros campos disponíveis
      // Veja a documentação completa da API para todos os campos
    }
  ]
}

​
3. Dicas para Respostas Grandes

Atenção ao volume de dados: As respostas da API podem ser extensas (vários KB por item). Para otimizar performance:
  • Use paginação adequada: Ajuste os parâmetros de página e limite conforme necessário
  • Filtre campos específicos: Alguns endpoints permitem selecionar apenas os campos necessários
  • Implemente cache: Para dados que não mudam frequentemente
  • Monitore timeouts: Configure timeouts adequados em suas requisições
# Exemplo com paginação menor para testes
curl -X GET "https://backend-pied-prod.piedadmin.com.br/api/v2/requests/budget/1/5" \
  -H "Authorization: Bearer SEU_TOKEN_AQUI"

​
4. Explore os Endpoints

Requests

Gerencie orçamentos e pedidos

Equipamentos

Acesse o catálogo de produtos

Empresas

Gerencie empresas parceiras

Colaboradores

Controle sua equipe

​
5. Configure Webhooks (Opcional)

Para receber notificações automáticas sobre mudanças em orçamentos e pedidos, configure webhooks diretamente na plataforma:
  1. Acesse sua plataforma PIED
  2. Vá até Configurações > API e Webhooks
  3. Clique na aba “Webhooks”
  4. Clique em “Adicionar”
  5. Preencha os campos:
    • Nome do webhook: Adicione um nome ao webhook
    • Endpoint para receber notificações: Endpoint do seu sistema que receberá as notificações
    • Gatilho de disparo: Selecione quais eventos deseja receber (ex: orçamento criado, pedido atualizado)
    • Tipo de autenticação: Selecione se é necessário autenticação para seu sistema
Configurar Webhooks
Dica: Teste seu webhook com ferramentas como ngrok para desenvolvimento local, ou use serviços como webhook.site para testar se as notificações estão sendo enviadas corretamente.

​
Próximos Passos