Use este guia para gerar um client ID e um secret de acesso à API, rotacionar credenciais quando necessário e gerenciar as credenciais de API da sua organização na interface do Payments Direct.
- Você precisa ter a permissão API Credentials: Can Edit.
- A sua organização pode ter no máximo 3 credenciais de API ao mesmo tempo.
Na navegação à esquerda, selecione Configurações.
Selecione Credenciais.
Selecione Nova credencial.
Se a sua organização já tiver 3 credenciais, o botão Nova credencial fica desabilitado. Exclua uma credencial existente antes de criar outra.
Informe um Nome da credencial para identificar a credencial na lista.
Selecione Salvar e gerar chave.
Aparece uma caixa de diálogo com os dados da credencial:
| Campo | Descrição |
|---|---|
| Audience | O valor de audience da API no seu ambiente. |
| Client ID | O identificador único desta credencial. |
| Secret | A chave secreta gerada. |
O secret é exibido apenas uma vez. Depois que você fechar esta caixa de diálogo, não será possível recuperá-lo. Copie o secret e guarde-o em local seguro antes de fechar.
- Copie o Client ID e o secret e depois selecione Fechar.
Rotacione uma credencial para gerar um novo secret mantendo o mesmo Client ID. Use isso quando um secret for comprometido ou como parte de uma rotina regular de rotação de credenciais.
- Na navegação à esquerda, selecione Configurações.
- Selecione Credenciais.
- No card da credencial que você quer rotacionar, selecione o menu de ações ....
- Selecione Rotacionar credencial.
- Na caixa de diálogo de confirmação, selecione Rotacionar credencial para confirmar.
Aparece uma caixa de diálogo com o novo secret da credencial rotacionada.
O novo secret é exibido apenas uma vez. O secret anterior é invalidado imediatamente. Copie e guarde o novo secret antes de fechar.
- Copie o novo secret e depois selecione Fechar.
Atualize os clientes de API ou integrações que usam o secret antigo para passarem a usar o novo.
- No card da credencial que você quer renomear, selecione o menu de ações ....
- Selecione Editar.
- Atualize o Nome da credencial.
- Selecione Salvar.
Você pode excluir credenciais não primárias que não sejam mais necessárias.
A credencial primária não pode ser excluída. Para removê-la, você precisa antes designar outra credencial como primária ou entrar em contato com o seu representante Ripple.
- No card da credencial que você quer excluir, selecione o menu de ações ....
- Selecione Excluir.
- Na caixa de diálogo de confirmação, selecione Excluir para confirmar.
A credencial é removida permanentemente. Quaisquer clientes de API que usem a credencial excluída perdem o acesso imediatamente.
- Use o Client ID e o secret para autenticar as requisições da API. Para instruções, consulte Solicitar um token de acesso.
- Se você precisar controlar quais endereços IP podem usar a API, fale com o seu representante Ripple sobre controles de acesso em nível de rede.