Comece por aqui · v1 em prévia
Uma credencial, um produtor, escopos explícitos.
Envie a credencial no cabeçalho Authorization em cada consulta.
Bearer token
A credencial é emitida pela administração e apresentada em claro uma única vez. O produtor é determinado pela credencial; parâmetros de consulta não selecionam outra conta.
Authorization: Bearer <sua-credencial>Escopos
Cada recurso exige a sua permissão. Peça só os escopos que a integração usa.
| Permissão | Recurso |
|---|---|
| products:read | GET /api/v1/products |
| sales:read | GET /api/v1/sales |
| access:read | GET /api/v1/access |
Armazenamento e revogação
Guarde o segredo fora do repositório, do navegador e dos logs. Em caso de exposição, solicite a revogação e a emissão de uma nova credencial. Uma credencial revogada passa a retornar 401.
Troca planejada de credencial
Solicite a nova chave
Informe os escopos necessários. Guarde o segredo na apresentação inicial, fora do código-fonte.
Atualize a integração
Substitua o segredo no ambiente autorizado e valide uma leitura com os recursos utilizados.
Revogue a anterior
Solicite a revogação e confirme que nenhum processo depende da chave antiga. Em caso de exposição, priorize a revogação imediata.
Dúvidas frequentes
Posso usar a mesma credencial para vários produtores?
Uma credencial está vinculada a um produtor. O contrato não permite escolher outra conta por query string.
Uma chave revogada volta a funcionar?
A revogação não é um mecanismo de pausa. Solicite uma nova credencial se precisar restabelecer o acesso.
Referência conferida em 23 de setembro de 2026. Relatar uma dúvida na documentação.