Integrações
Integre sistemas e plataformas ao Portal Rain Bird usando autenticação M2M por chave de API
Integrações
O Portal Rain Bird disponibiliza uma API REST dedicada para integrações (Totvs, SAP, sistemas internos e terceiros) sincronizarem dados de negócio de forma bidirecional.
Autenticação
Todos os endpoints de integração requerem uma chave de API no header X-API-Key:
X-API-Key: rbk_sua_chave_aquiAs chaves de API são gerenciadas por administradores do portal em POST /api-keys. Cada chave é exibida uma única vez na criação — armazene-a com segurança.
Headers Obrigatórios
| Header | Obrigatório | Descrição |
|---|---|---|
X-API-Key | Sim | Chave M2M |
x-tenant-id | Sim | ID de domínio do tenant alvo |
Escopos
As chaves de API têm acesso por escopo:
| Escopo | Descrição |
|---|---|
customers:read | GET /integrations/customers |
customers:write | POST/PUT /integrations/customers |
products:read | GET /integrations/products |
products:write | POST/PUT /integrations/products |
orders:read | GET /integrations/orders |
invoices:read | GET /integrations/invoices |
invoices:write | POST/PUT /integrations/invoices |
Downloads da Documentação
Importe a coleção no Postman e configure as variáveis:
baseUrl— URL do seu Portal Rain Birdapi_key— sua chave de APItenant_id— ID de domínio do tenantjwt_token— JWT de admin do portal (apenas para endpoints/api-keys)
Documentação Interativa
Em ambiente de desenvolvimento, acesse /api/docs/integrations para o Swagger UI com todos os endpoints de integração.