API de integração (v1)
Como autenticar e usar a API pública do OSBPulse para produtos, clientes e oportunidades.
A API de integração fica sob o prefixo /api/v1. Ela é pensada para sistemas externos (ERP parceiro, e-commerce, ETL), autenticados com chave de API da organização.
Autenticação
- No produto (usuário logado): Organização → API — gere uma chave (
pk_…). - Em cada chamada envie:
- Cabeçalho
X-API-Key: pk_…ouAuthorization: Bearer pk_… - Organização: query
id_organizationou cabeçalhoX-Organization-Id
- Cabeçalho
Guarde a chave como segredo. Revogue e rode quando houver vazamento.
Endpoints de integração
| Método | Rota | Uso |
|---|---|---|
| GET | /api/v1/products |
Lista produtos |
| GET | /api/v1/clients |
Lista clientes ativos |
| POST | /api/v1/clients |
Cria cliente |
| POST | /api/v1/opportunities |
Cria oportunidade no CRM |
Especificação máquina: /api/v1/openapi.json.
Interface interativa (Swagger): dentro do produto em Organização → API → Documentação.
Exemplo
curl -s "https://SEU_HOST/api/v1/products?id_organization=1" \
-H "X-API-Key: pk_..."
Links públicos (sem chave)
Algumas rotas usam token na URL (assinatura, base de conhecimento, verificação). São fluxos de usuário final, não o mesmo contrato da chave de integração.
Relação com webhooks
A API é o caminho para ler e escrever dados. Os webhooks e eventos são o caminho para reagir quando algo muda no Pulse — em geral você combina os dois no mesmo app externo.