> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pied.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Introdução à API

> A API PIED oferece uma interface moderna e robusta para gerenciar todos os aspectos do seu sistema de energia solar, incluindo orçamentos, pedidos, equipamentos, empresas e colaboradores.

## Recursos Principais

A API PIED oferece acesso aos dados e atualizações do seu sistema de energia solar:

### Orçamentos e Pedidos

* **Consulta**: Retorna dados de orçamentos ou pedidos com paginação
* **Atualização de Status**: Atualiza o status de orçamentos/pedidos
* **Atualização de Pagamento**: Atualiza informações de pagamento
* **Descontos**: Atualiza percentual de desconto
* **Responsável**: Atualiza o responsável pelo orçamento/pedido
* **Exclusão**: Remove orçamentos/pedidos
* **Status Disponíveis**: Lista os status possíveis

### Equipamentos

* **Consulta**: Retorna informações sobre equipamentos do catálogo
* **Atualização de Preços**: Atualiza preço base e de custo
* **Atualização de Estoque**: Atualiza quantidade em estoque

### Empresas

* **Consulta**: Retorna dados das empresas de energia
* **Busca por ID**: Retorna dados de uma empresa específica
* **Criação**: Cria uma ou mais empresas de energia

### Colaboradores

* **Consulta**: Retorna dados dos colaboradores
* **Busca por ID**: Retorna dados de um colaborador específico

### Campos Customizados

* **Consulta**: Retorna campos customizados de uma entidade
* **Atualização**: Atualiza valores de campos customizados

## Recursos Adicionais

<CardGroup cols={3}>
  <Card title="Webhooks" icon="webhook" href="/webhooks/introduction">
    Configure notificações em tempo real (v2)
  </Card>

  <Card title="Integrações" icon="plug" href="/integrations/introduction">
    Conecte com Zapier, Make, N8N e mais
  </Card>

  <Card title="Central de Ajuda" icon="circle-question" href="https://suportepied.tawk.help/">
    Suporte e documentação adicional
  </Card>
</CardGroup>

<Note>
  **🚀 Recomendamos usar a v2** - A versão 2 da API PIED oferece melhor performance, novos recursos e documentação completa. Use a v2 para todos os novos projetos.
</Note>

## Versões da API

A API PIED está disponível em duas versões:

### API v2 (Recomendada)

A v2 é nossa versão principal e recomendada, oferecendo:

<CardGroup cols={2}>
  <Card title="Melhor Performance" icon="rocket">
    Endpoints otimizados com tempos de resposta reduzidos
  </Card>

  <Card title="Novos Recursos" icon="sparkles">
    Webhooks, campos customizados e funcionalidades aprimoradas
  </Card>

  <Card title="Documentação Completa" icon="book-open">
    Exemplos claros e documentação interativa detalhada
  </Card>

  <Card title="Suporte Ativo" icon="headset">
    Atualizações constantes e suporte completo
  </Card>
</CardGroup>

**Base URL v2:** `https://backend-pied-prod.piedadmin.com.br/api/v2`

### API v1

A v1 mantém endpoints específicos e estáveis para casos de uso que não necessitam dos novos recursos da v2.

**Base URL v1:** `https://backend-pied-prod.piedadmin.com.br/api/v1`

<Info>
  **Quando usar v1:** Se você já possui integrações funcionais que não precisam dos novos recursos, ou precisa de endpoints específicos disponíveis somente na v1.
</Info>

## Próximos Passos

<CardGroup cols={2}>
  <Card title="Primeiros Passos" icon="play" href="/docs/quickstart">
    Configure sua primeira requisição em minutos
  </Card>

  <Card title="Referência da API" icon="code" href="/api-reference/v2/overview">
    Explore todos os endpoints disponíveis
  </Card>
</CardGroup>