Desenvolvedores · Credenciais
Acesso de máquina com privilégio mínimo.
Chaves de API identificam integrações e devem ter escopo, responsável e ciclo de vida. Segredos aparecem somente quando necessário e não devem entrar em repositórios ou aplicativos cliente.
Visão executiva
O essencial antes de operar
Intenção atendida: Criar, armazenar, restringir, rotacionar e revogar credenciais de API com menor privilégio e rastreabilidade.
- Uma chave pertence a uma integração e ambiente.
- O segredo completo aparece somente quando necessário.
- Escopos limitam funções, não substituem autorização por objeto.
- Rotação precisa evitar interrupção.
- Vazamento exige revogação e investigação imediatas.
01
O que esta solução organiza
Chaves de API identificam integrações e devem ter escopo, responsável e ciclo de vida. Segredos aparecem somente quando necessário e não devem entrar em repositórios ou aplicativos cliente. O desenho da jornada separa claramente solicitação, validação, confirmação e conciliação. Assim, cada participante sabe o que precisa ocorrer antes de avançar.
Criação e revogação controladas
Escopos compatíveis com a integração
Registro de uso e rotação planejada
02
Como funciona, etapa por etapa
- 01
Crie uma chave para cada integração
- 02
Aplique somente os escopos necessários
- 03
Armazene o segredo em ambiente seguro
- 04
Rotacione e revogue quando houver risco
03
Qualidade operacional por padrão
Antes de confirmar qualquer operação, revise titularidade, valores, moeda ou ativo, rede quando aplicável, prazos, tarifas e destinatários. Dados enviados por canais não verificados não devem ser usados para transferências.
A Digittro apresenta estas informações para explicar o produto, e não como promessa de aprovação, rentabilidade, disponibilidade contínua ou aconselhamento financeiro, jurídico ou tributário.
03
Uma identidade por integração
Compartilhar a mesma chave entre sistemas impede atribuir uso, limitar impacto e rotacionar sem interromper tudo. Cada serviço recebe credencial própria, ambiente, proprietário, finalidade e escopos. Nomes claros ajudam a identificar a integração, mas nunca contêm o segredo.
A chave autentica a aplicação; o backend ainda verifica merchant, recurso e operação. Escopo amplo não autoriza acessar objeto de outro titular. Permissões administrativas e financeiras são separadas quando o produto permitir.
04
Exibição e armazenamento seguro
O segredo completo é mostrado uma vez na criação ou por fluxo controlado e não reaparece em listagens. A aplicação armazena hash ou metadados adequados para identificação e verificação, enquanto o integrador usa cofre de segredos ou variável protegida no servidor. Logs exibem somente prefixo reconhecível.
Chaves não entram em JavaScript público, aplicativo móvel distribuído, URL, ticket ou repositório. Scanners de segredo, revisão de código e proteção de CI ajudam a detectar exposição antes e depois da publicação.
05
Rotação, revogação e resposta
Rotação segura permite criar nova credencial, atualizar consumidores, verificar uso e então revogar a anterior dentro de uma janela curta e definida. O painel mostra última utilização, origem agregada e escopos para apoiar a decisão sem revelar payloads.
Em suspeita, a chave é revogada imediatamente; depois são revisados logs, objetos acessados e alterações realizadas. Criar outra chave sem investigar mantém o incidente aberto. Credenciais inativas expiram conforme política, e contas de pessoas que saíram da organização perdem acesso administrativo.
Ações de criar, alterar escopos, rotacionar e revogar exigem autenticação forte e trilha de auditoria. Alertas de uso anômalo consideram contexto e permitem contenção sem prometer detecção perfeita.
Restrições adicionais, como origem de rede, horário ou limite, podem reduzir exposição quando compatíveis com a integração, mas precisam de modo seguro de recuperação. Uma regra excessivamente rígida que leva equipes a compartilhar credenciais por atalhos piora a segurança. O desenho equilibra menor privilégio, continuidade e capacidade de responder rapidamente.
Revisões periódicas removem chaves órfãs, confirmam proprietários e comparam escopos com o uso observado. Ausência de chamadas não prova que uma credencial possa permanecer ativa indefinidamente.
Comparativo
Credenciais: ciclo de vida e contenção
| Dimensão | Contrato necessário | Evidência |
|---|---|---|
| Requisição | Método, rota, campos e autenticação | Exemplo e schema |
| Resposta | Status, corpo e identificador | Contrato versionado |
| Falha | Código, detalhe e possibilidade de retry | Erro estruturado |
| Repetição | Idempotência e deduplicação | Chave e resultado original |
| Operação | Logs, métricas e correlação | Request ID e auditoria |
A documentação pública deve descrever somente recursos realmente implementados e disponíveis no ambiente correspondente.
Checklist
Antes de solicitar uma cotação
- 01
Definir caso de uso e ambiente.
- 02
Criar credencial com privilégio mínimo.
- 03
Validar contrato e exemplos oficiais.
- 04
Implementar timeout, retry e idempotência.
- 05
Tratar erros por código e estado.
- 06
Validar eventos e assinaturas no servidor.
- 07
Monitorar request IDs, latência e falhas.
Vocabulário
Termos usados nesta página
- API
- Interface programática com contrato documentado.
- Endpoint
- Combinação de método e rota para um recurso.
- Request ID
- Identificador usado para correlacionar uma requisição.
- Idempotência
- Repetição segura que preserva o efeito esperado.
- Webhook
- Evento enviado para um endpoint do integrador.
- Escopo
- Conjunto de permissões associado à credencial.
Fontes
Referências institucionais
Links externos usados para contextualização normativa e educação financeira. Nenhum direciona a concorrentes.
04
Perguntas frequentes
A chave pode ficar no JavaScript do site?+
Não. Credenciais secretas devem ser usadas pelo servidor.
Devo compartilhar uma chave entre sistemas?+
Prefira uma chave por integração para limitar impacto e melhorar auditoria.
O que fazer em caso de vazamento?+
Revogue imediatamente, crie nova credencial e revise logs e escopos.