API pública
Acessar propostas, clientes e produtos por programação.
O sistema tem uma API (uma porta de entrada para outros programas) que permite listar e criar propostas, clientes e produtos por fora da interface. E voltada para quem tem apoio técnico para integrar sistemas.
Como autenticar
- 1Gere uma chave em Configurações, aba API, clicando em Nova chave de API.
- 2Copie a chave, ela começa com pb_live_.
- 3Em toda requisição, envie o header Authorization no formato: Bearer sua_chave_aqui.
- 4As respostas vem em JSON, paginadas, e aceitam filtros de busca pelos parametros da URL.
Recursos disponíveis
- GET e POST /api/v1/clients: listar e criar clientes.
- GET e POST /api/v1/proposals: listar e criar propostas.
- PATCH /api/v1/proposals/{id}/status: mudar o status de uma proposta.
- GET e POST /api/v1/products: listar e criar produtos.
- GET e POST /api/v1/webhooks: gerenciar assinaturas de webhook.
Documentação técnica completa da APITodos os endpoints, com exemplos de requisição em cURL e de resposta em JSON.
Observação
Este é um recurso técnico. Se você não vai integrar outros sistemas, pode ignorar esta área com tranquilidade.