Aprenda como configurar o OAuth para seu aplicativo usando este guia de início rápido e o aplicativo Node.js de exemplo.
Campos marcados com * são obrigatórios.
Parâmetro | Descrição | Exemplo |
---|---|---|
client_id * | O ID do cliente identifica seu aplicativo. Encontre-o na página de configurações do seu aplicativo. | 7fff1e36-2d40-4ae1-bbb1-5266d59564fb |
scope * | Os escopos que seu aplicativo está solicitando, separados por espaços codificados por URL (%20 ). | oauth%20crm.objects.contacts.read |
redirect_uri * | O URL para o qual o usuário será redirecionado depois que ele autorizar seu aplicativo para os escopos solicitados. Para aplicações de produção, https é necessário. | https://www.example.com/auth-callback |
optional_scope | Os escopos que são opcionais para o aplicativo e serão ignorados se o portal do HubSpot selecionado não tiver acesso a esses produtos | automation |
state | Um valor de sequência de caracteres exclusivo que pode ser usado para manter o estado do usuário quando ele é redirecionado de volta ao seu aplicativo. | WeHH_yy2irpl8UYAvv-my |
userA.integration.com
e userB.integration.com
). Para fazer isso, use o parâmetro state
para codificar mais informações sobre o estado do usuário:
1. Gerencie e armazene um valor nonce para o parâmetro state.
2. Armazene o estado do usuário em um armazenamento de dados local usando o nonce como sua chave.
3. Inclua o valor nonce como o parâmetro state no URL de autorização.
4. Quando o usuário for autenticado e redirecionado para o URL de redirecionamento, valide o parâmetro state e use-o como a chave para recuperar o estado do usuário que foi armazenado.
5. Depois, redirecione o usuário conforme necessário (por exemplo, redirecionar novamente para um URL específico do usuário).
GET
para o URI especificado em seu URL de autenticação. Se não houver problemas e o usuário aprovar a solicitação de acesso, a solicitação para o URI de redirecionamento será devolvida com um parâmetro de consulta code
anexado. Se o usuário não conceder acesso, nenhuma solicitação será enviada.
Exemplo:
POST
codificada por formulário para https://api.hubapi.com/oauth/v1/token
com os valores mostrados abaixo. Para obter informações mais detalhadas sobre essa etapa, reserve um tempo para ler este documento de referência.
Parâmetro | Descrição | Exemplo |
---|---|---|
grant_type | Deve ser authorization_code | authorization_code |
client_id | ID do cliente de seu aplicativo | 7fff1e36-2d40-4ae1-bbb1-5266d59564fb |
client_secret | O segredo do cliente de seu aplicativo | 7c3ce02c-0f0c-4c9f-9700-92440c9bdf2d |
redirect_uri | O URI de redirecionamento de quando o usuário autorizou seu aplicativo | https://www.example.com/auth-callback |
code | O código de autorização recebido do servidor OAuth 2.0 | 5771f587-2fe7-40e8-8784-042fb4bc2c31 |
expires_in
da resposta, atualmente 30 minutos. Para obter detalhes sobre como obter um novo token de acesso, consulte a seção Atualizando tokens OAuth abaixo.Authorization
. Detalhes específicos podem ser encontrados no documento de referência.
Exemplo:
crm.objects.contacts.read
, o token de acesso resultante poderá visualizar todos os contatos na conta e não apenas aqueles de propriedade do usuário que está autorizando.expires_in
quando um código de autorização é trocado para um token de acesso.
Seu aplicativo pode trocar o token de atualização recebido por um novo token de acesso enviando uma solicitação POST
para https://api.hubapi.com/oauth/v1/token
com os valores abaixo. Para obter informações mais detalhadas sobre essa etapa, consulte o documento de referência.
Parâmetro | Descrição | Exemplo |
---|---|---|
grant_type | Deve ser refresh_token | refresh_token |
client_id | ID do cliente de seu aplicativo | 7fff1e36-2d40-4ae1-bbb1-5266d59564fb |
client_secret | O segredo do cliente de seu aplicativo | 7c3ce02c-0f0c-4c9f-9700-92440c9bdf2d |
redirect_uri | O URI de redirecionamento de quando o usuário autorizou seu aplicativo | https://www.example.com/auth-callback |
refresh_token | O token de atualização recebeu quando o usuário autorizou seu aplicativo | b9443019-30fe-4df1-a67e-3d75cbd0f726 |