Skip to main content

​
Base URLs

A API PIED está disponível em duas versões: API v2 (Recomendada): 
https://backend-pied-prod.piedadmin.com.br/api/v2
API v1: 
https://backend-pied-prod.piedadmin.com.br/api/v1

​
Autenticação

Todas as requisições requerem autenticação via Bearer Token: 
Authorization: Bearer SEU_TOKEN_AQUI

​
Formato de Dados

  • Request: JSON com Content-Type: application/json
  • Response: JSON com dados estruturados
  • Encoding: UTF-8

​
Códigos de Status HTTP

CódigoSignificado
200Sucesso - dados retornados
204Sucesso - nenhum conteúdo
400Erro na requisição
401Não autorizado
404Recurso não encontrado
429Limite de requisições excedido
500Erro interno do servidor

​
Paginação

Endpoints que retornam listas usam paginação baseada em página: 
GET /requests/budget/{pageNumber}/{pageLimit}

​
Parâmetros

  • pageNumber: Número da página (inicia em 1)
  • pageLimit: Itens por página (máximo 50)

​
Resposta

{
  "data": [...],
  "totalItems": 340  
}

​
Rate Limiting

A API implementa limites de uso:
  • 600 requisições por hora geral
  • 1 minuto de processamento por hora
Quando excedido, retorna erro 429 e a API será desativada. Para reativar, entre em contato com suporte

​
Filtros de Data

Muitos endpoints aceitam filtros de data no formato YYYY-MM-DD:
  • createdAfter: Registros criados após esta data
  • createdBefore: Registros criados antes desta data
  • lastUpdateAfter: Registros atualizados após esta data
  • lastUpdateBefore: Registros atualizados antes desta data

​
Recursos Disponíveis

Requests

Consulta e atualização de orçamentos e pedidos (v2 e v1)

Empresas

Criação (v2) e consulta (v1) de empresas parceiras

Equipamentos

Consulta de catálogo (v2), atualização de preços (v2) e estoque (v1)

Colaboradores

Consulta de dados de colaboradores (v1)

Campos Customizados

Consulta e atualização de campos customizados (v2)

​
Versionamento

Esta documentação unificada apresenta endpoints de ambas as versões da API:
  • 🚀 v2 (Recomendada): Versão principal com melhor performance e novos recursos
  • v1: Mantém endpoints específicos para casos de uso que não necessitam das melhorias da v2
Identificação de versão: Cada endpoint indica claramente qual versão da API ele pertence. Use endpoints v2 sempre que possível para novos projetos.

​
Suporte

Para dúvidas técnicas ou problemas:
  • Email: [email protected]
  • Documentação: Esta documentação interativa
  • Status: Monitore o status da API em tempo real