Chaves de acesso
Autenticação na Partner Hub API
Para garantir uma comunicação segura entre o servidor do seu sistema e a API do Partner Hub, utilizamos um processo de autenticação que combina criptografia assimétrica (chave pública e privada) e JSON Web Tokens (JWT). Este processo protege o acesso aos recursos da API, assegurando que apenas usuários e sistemas autorizados possam interagir com nossos serviços.
Para detalhes da implementação prática, veja aqui.
| Ambiente | Tipo de Chave | Quando usar |
|---|---|---|
| Teste | Chave privada, vinculada a sua aplicação na Partner Hub API e disponibilizada no modo teste. | Disponibilizado para criação e implementação da integração. Nele, podem ser feitos testes para analisar o código e entender as funcionalidades a partir de transações que não processam recebíveis reais. |
| Produção | Chave privada, vinculada a sua aplicação na Partner Hub API e disponibilizada no modo de produção. | Este modo deve ser ativado quando o parceiro estiver pronto para lançar o produto e a homologação for aprovada. 📘 Neste ambiente são geradas operações reais |
⚠️ As informações armazenadas são dados sensíveis. Mantenha sua chave em sigilo e não a compartilhe com ninguém.
Para acessar sua chave na Plataforma é necessário:
- Estar cadastrado no Stone Partner Program;
- Acessar o Partner Hub;
- Solicitar suas chaves ao time de integração pelo canal de suporte "Guru".
- O envio e a visualização é única, não persistimos os dados de chave nos nossos bancos de dados.
Permissionamento de chaves
Dependendo da demanda as chaves disponibilizadas pelo Partner Hub podem ter permissões personalizadas, ou seja, acessar apenas alguns endpoints da API. Para saber mais entre em contato com o nosso time de integração ou com o seu BizDev.
Como Funciona a Autenticação
Geração de Chaves
Ao integrar com a Partner Hub API, serão geradas três dados você essenciais, receberá dois deles:
- Chave Pública: Armazenada de forma segura nos servidores do Partner Hub.
- Chave Privada: Será exibida apenas uma vez no painel da API (One Time View🚨), garantindo segurança. Guarde-a com cuidado.
- ClientID: Identificador da parceria que está autenticando na Partner Hub API.
Estas chaves são geradas pelo time de integração, para isso precisa antes estar inscrito no Stone Partner Program e já ter acesso ao Partner Hub.
Desafio
- O Partner Hub vai localizar a chave pública associada ao seu Client ID e usá-la para criptografar um token JWT temporário (válido por 24 horas). Esse token é assinado com uma chave secreta para garantir sua autenticidade.
- O token criptografado será devolvido na requisição.
Descriptografia
- Seu sistema deve usar a chave privada fornecida anteriormente para descriptografar o token JWT e, assim, obter o token válido.
- Para descriptografar é preciso da chave privada, client_id e do token JWT.
Envio do Token**
- Após descriptografar o token JWT, você deve incluí-lo no cabeçalho das requisições HTTPS que fizer à API (Bearer token). Esse token será validado pela Partner Hub API para garantir que ele foi corretamente assinado e está dentro do tempo de validade (24 Horas).
Segurança Adicional
Para garantir que seu sistema e a API mantenham um alto nível de segurança, o token JWT gerado pelo Partner Hub tem uma validade de 24 horas. Isso significa que após esse período, um novo token deve ser gerado através do mesmo processo de "desafio". Além disso:
- O token é criptografado usando sua chave pública, o que significa que apenas o seu sistema, com a chave privada, pode acessá-lo.
- A chave privada nunca é compartilhada com o Partner Hub, mantendo sua segurança em alto nível. Por isso é preciso armazená-lá com segurança no seu ambiente.
Updated 30 days ago