These docs are for v1. Click to read the latest docs for v5.

Chaves de acesso

Para usar todas rotas disponíveis em nossa API, você vai precisar de duas chaves numéricas. São elas a API Key e a Encryption Key.

Obs.: as duas são encontradas em sua Dashboard, nas versões de LIVE e TESTE, de acordo com o ambiente que você estiver usando.

Isto é, se você abrir a Dashboard no modo de produção (live), as chaves mostradas serão somente as de produção, já se alternar para o modo de teste (test), as chaves mostradas servem apenas para fazer testes com a nossa API, sem gerar transações reais.

915

Acesse essas informações na Dashboard pelo link: Chaves de API

API Key:

Essa chave é a mais importante para o nosso sistema, pois ela funciona como uma forma de autenticação intransferível para a sua empresa (company). Ela é obrigatória para que a sua aplicação consiga criar transações, planos, transferências etc. É extremamente importante que você mantenha essa chave segura, dada a sua sensibilidade.

A API key começa com o prefixo ak_, os próximos 4 dígitos identificam qual o ambiente que essa key poderá ser usada para autenticar o usuário live ou test, em seguida, temos alguns caracteres aleatórios gerados pela nossa API.

Encryption Key:

Essa chave tem um nível de acesso menor do que o da API Key. Ela também serve como uma forma de autenticação, mas você pode usá-la apenas para geração de chaves públicas para encriptação de dados.

A encryption key começa com o prefixo ek_, os próximos 4 dígitos identificam qual o ambiente que essa key poderá ser usada para autenticar o usuário live ou test, em seguida, temos alguns caracteres aleatórios gerados pela nossa API.

🚧

Ambiente de teste e produção

Atenção! Operações feitas usando uma chave de teste não geram recebíveis reais. Se você quiser criar transações reais, é preciso usar uma chave de produção.

❗️

Chave de Casa

Pense que sua chave de api, e de criptografia, são as chaves de sua casa. Você compartilharia a chave de sua casa com qualquer um?
Mantenha suas chaves de api em sigilo, e não compartilhe com ninguém, são dados sensíveis aos quais apenas você deve ter acesso.


Próximo

Aprenda agora o que é o versionamento da API e como ele pode afetar a sua operação.