Autenticação Oauth2

O Cryptohopper usa Oauth2 para fornecer acesso autorizado à sua API.

Usando Oauth2

Entender como funciona o OAuth2 pode te ajudar a criar e depurar aplicações que usam a API do Cryptohopper. Para usar o OAuth, um aplicativo precisa:

  • Obter tokens de concessão para agir em nome de uma conta de usuário.
  • Trocar tokens de concessão por tokens de acesso.
  • Autorizar todas as requisições HTTP enviadas às APIs do Cryptohopper.

O método de autenticação de usuário permite que um app aja em nome do usuário, como se fosse o próprio usuário.

Exemplo: se um desenvolvedor quisesse criar um recurso que permitisse um robô de negociação comprar uma determinada moeda em sua plataforma usando o endpoint de compra, o desenvolvedor precisaria utilizar a autenticação do usuário para obter permissão do usuário para negociar em seu nome.

Cada requisição à API que seu app faz em nome de um usuário leva o token de acesso desse usuário. O token informa à Cryptohopper qual app está chamando e quais permissões o usuário concedeu a ele.

Para obter um token de acesso, seu app precisa da chave do app (client_id) e do segredo do app (client_secret). Envie o token de acesso no cabeçalho access-token de cada requisição à API; um cabeçalho Authorization: Bearer não é aceito. Mais sobre os métodos OAuth abaixo:

Métodos Oauth2

authorize

Com o endpoint authorize, os usuários podem fazer login no Cryptohopper e conceder acesso ao aplicativo. Após a concessão de acesso bem-sucedida ou após qualquer erro, o usuário será redirecionado para o URL de redirecionamento. Se o URL de redirecionamento não for especificado na solicitação, o URL de redirecionamento da configuração do aplicativo será usado. Nos parâmetros GET do URL de redirecionamento, você receberá o token de concessão que pode ser trocado por um access_token.


Endpoint: https://www.cryptohopper.com/oauth2/authorize

Aceita: GET

Retorna: code, state em GET no URL de redirecionamento

Parâmetros:

  • client_id: A chave da sua aplicação.
  • response_type: O tipo de resposta deve conter o texto: code.
  • redirect_uri: O URL de redirecionamento para onde os usuários serão redirecionados após o processo OAuth.
  • state: Parâmetro extra para reconhecer solicitações do lado do aplicativo. Será retornado para o URL de redirecionamento.
  • scope: Uma lista separada por vírgula de escopos, por exemplo: read,notifications,manage,trade.

 

token

O endpoint token é usado para trocar um token/código de concessão por um access_token válido.


Endpoint: https://www.cryptohopper.com/oauth2/token

Aceita: POST em application/json

Retorna: access_token e refresh_token em application/json

Parâmetros:

  • client_id: A chave da sua aplicação.
  • client_secret: O segredo da sua aplicação.
  • grant_type: O tipo de concessão deve conter o texto: authorization_code.
  • redirect_uri: O URL de redirecionamento do seu aplicativo.
  • code: O token/código de concessão.

 


Códigos de resposta bem-sucedidos

Quando uma solicitação ao endpoint access_token é bem-sucedida, o usuário será redirecionado para o URL de redirecionamento com um token de concessão passado como parâmetros GET.

Uma solicitação bem-sucedida ao endpoint token terá um código de resposta 200 e incluirá um access_token no corpo, que pode ser usado para autenticar chamadas API.

Códigos de resposta de erro

Erros retornados ao URL de redirecionamento são reconhecíveis pelo parâmetro GET retornado: error=1. Abaixo você encontrará possíveis mensagens de erro:

  • Chave da aplicação inválida.
  • Assinatura inválida.
  • A chave da aplicação não pode estar vazia.
  • O usuário não concedeu permissão ao aplicativo.

Permissões

Seu app pede escopos no parâmetro scope da requisição de autorização, e o usuário os vê antes de conceder o acesso. Peça só o que seu app precisa. A referência da API informa os escopos de cada endpoint.

readLer hoppers, posições, ordens, negociações, configurações e dados do marketplace. Quase todo endpoint precisa dele.
manageCriar, alterar e excluir hoppers, configurações, templates e estratégias, e cancelar ou remover ordens.
tradeCriar ordens, vender, operar vendido ou fazer DCA em posições e usar o botão de pânico.
notificationsReceber notificações por webhook sobre os hoppers do usuário.
userLer e alterar o perfil, os créditos, as compras e as configurações de conta do usuário.
emailLer o endereço de e-mail do usuário.