Si es la primera vez que usas la autenticación OAuth con las API de HubSpot, te recomendamos que consultes la Aplicación de inicio rápido de OAuth 2.0, escrita en Node.js. Esta aplicación está diseñada para que puedas comenzar a usar OAuth 2.0 lo más rápido posible mediante la demostración de todos los pasos que se detallan a continuación en la sección Obtener tokens de OAuth 2.0.
1. Crea la URL de autorización y dirige al usuario al servidor OAuth 2.0 de HubSpot
Al enviar un usuario al servidor OAuth 2.0 de HubSpot, el primer paso es crear la URL de autorización. Esto identificará tu aplicación y definirá los recursos (los permisos) a los que solicita acceso en nombre del usuario. Los parámetros de consulta que puedes pasar como parte de una URL de autorización se muestran a continuación. Para obtener información más detallada sobre este paso, lee el documento de referencia.
Los campos marcados con * son
obligatorios.
Parámetro
Descripción
Ejemplo
client_id*
El ID del cliente identifica tu aplicación. Encuéntralo en la página de configuración de tu aplicación.
7fff1e36-2d40-4ae1-bbb1-5266d59564fb
scope*
Los permisos que tu aplicación solicita, separados por espacios codificados de URL (%20).
oauth%20crm.objects.contacts.read
redirect_uri*
La URL a la que el usuario será redirigido después de autorizar a tu aplicación para los permisos solicitados. Para aplicaciones en producción, se requiere https.
https://www.example.com/auth-callback
optional_scope
Los permisos que son opcionales para tu aplicación y se eliminarán si el portal de HubSpot seleccionado no tiene acceso a esos productos
automation
state
Un valor de cadena que se puede usar para mantener el estado del usuario cuando se redirecciona de regreso a tu aplicación.
WeHH_yy2irpl8UYAvv-my
Una vez que hayas creado tu URL, envía al usuario a OAuth 2.0 para iniciar el proceso.Los bloques de código que aparecen a continuación ofrecen ejemplos de utilización de distintos tipos de redireccionamiento:Usando una redirección del lado del servidor:
Reportar código incorrecto
Copiar
Preguntar a la IA
// Build the auth URLconst authUrl = "https://app.hubspot.com/oauth/authorize" + `?client_id=${encodeURIComponent(CLIENT_ID)}` + `&scope=${encodeURIComponent(SCOPES)}` + `&redirect_uri=${encodeURIComponent(REDIRECT_URI)}` + `&state=${encodeURIComponent(STATE)}`;// Redirect the userreturn res.redirect(authUrl);
Codificación de un estado adicional de redirección del usuarioAlgunas aplicaciones pueden necesitar redirigir al usuario a diferentes ubicaciones. Por ejemplo, es posible que una aplicación desee redirigir a los usuarios a diferentes subdominios de su integración (por ejemplo, userA.integration.com y userB.integration.com). Para ello, utiliza el parámetro state para codificar más información sobre el estado del usuario:1. Genera y almacena un valor “nonce” para el parámetro de estado.2. Almacena el estado del usuario en un almacén de datos local utilizando el “nonce” como su clave.3. Incluye el valor “nonce” como el parámetro de estado en la URL de autorización.4. Cuando el usuario se autentica y es redirigido a tu URL de redirección, valida el parámetro de estado y úsalo como la clave para recuperar el estado de usuario que estaba almacenado.5. Desde allí, redirige al usuario según sea necesario (por ejemplo, redirige de nuevo a una URL específica del usuario).
HubSpot muestra una ventana de consentimiento al usuario que muestra el nombre de tu aplicación y una breve descripción de los servicios de la API de HubSpot a los que solicita permiso para acceder. El usuario puede otorgar acceso a tu aplicación.
Nota: El usuario que instala la aplicación debe tener acceso a todos los permisos solicitados. Si no tienen el acceso requerido, la instalación fallará y serán dirigidos a una página de error. Si un usuario ve esta página de error de permisos, necesitará que un superadministrador instale la aplicación.Tu aplicación no hace nada en esta etapa. Una vez que se otorga el acceso, el servidor de OAuth 2.0 de HubSpot enviará una solicitud a la URI de devolución de llamada definida en la URL de autorización.
Cuando el usuario haya completado la solicitud de consentimiento del paso 2, el servidor OAuth 2.0 envía una solicitud GET al URI de redireccionamiento especificado en tu URL de autenticación. Si no hay problemas y el usuario aprueba la solicitud de acceso, la solicitud al URI de redireccionamiento se devolverá con un parámetro de consulta de code adjunto. Si el usuario no otorga el acceso, no se enviará ninguna solicitud.Ejemplo:
Reportar código incorrecto
Copiar
Preguntar a la IA
app.get("/oauth-callback", async (req, res) => { if (req.query.code) { // Handle the received code }});
4. Intercambiar el código de autorización por tokens
Después de que tu aplicación reciba un código de autorización del servidor OAuth 2.0, puede intercambiar ese código por un token de acceso y actualización al enviar una solicitud POST codificada en formato de formulario URL a https://api.hubapi.com/oauth/v1/token con los valores que se muestran a continuación. Para obtener información más detallada sobre este paso, puedes leer este documento de referencia.
Parámetro
Descripción
Ejemplo
grant_type
Debe ser authorization_code
authorization_code
client_id
ID de cliente de tu aplicación
7fff1e36-2d40-4ae1-bbb1-5266d59564fb
client_secret
La clave de cliente de tu aplicación
7c3ce02c-0f0c-4c9f-9700-92440c9bdf2d
redirect_uri
El URI de redireccionamiento desde el momento en que el usuario autorizó tu aplicación
https://www.example.com/auth-callback
code
El código de autorización recibido del servidor OAuth 2.0
El token de acceso vencerá después de la cantidad de segundos indicada en el campo expires_in de la respuesta, actualmente, 30 minutos. Para más detalles sobre cómo obtener un nuevo token de acceso, consulta la sección Actualizar tokens OAuth más abajo.
Una vez que se complete el proceso de autorización, tu aplicación está autorizada para realizar solicitudes en nombre del usuario. Para ello, proporciona el token como token de portador en el encabezado HTTP Authorization. Los detalles específicos se pueden encontrar en el documento de referencia.Ejemplo:
Los tokens de acceso reflejan los permisos solicitados desde la aplicación y no reflejan los permisos o limitaciones de lo que un usuario puede hacer en su cuenta de HubSpot. Por ejemplo, si un usuario tiene permisos para ver solo los contactos de su propiedad, pero autoriza una solicitud para el permiso crm.objects.contacts.read, el token de acceso resultante puede ver todos los contactos de la cuenta y no solo los que son propiedad del usuario que autoriza.
Los tokens de acceso de OAuth caducan periódicamente. Así se limita el acceso de los atacantes a un corto plazo si se produce una vulneración. La vida útil del token en segundos se especifica en el campo expires_in cuando se intercambia un código de autorización por un token de acceso.Tu aplicación puede intercambiar el token de actualización recibido por un nuevo token de acceso enviando una solicitud POST codificada en formato de formulario URL a https://api.hubapi.com/oauth/v1/token con los siguientes valores. Para obtener información más detallada sobre este paso, consulta el documento de referencia.
Parámetro
Descripción
Ejemplo
grant_type
Debe ser refresh_token
refresh_token
client_id
ID de cliente de tu aplicación
7fff1e36-2d40-4ae1-bbb1-5266d59564fb
client_secret
La clave de cliente de tu aplicación
7c3ce02c-0f0c-4c9f-9700-92440c9bdf2d
redirect_uri
El URI de redireccionamiento desde el momento en que el usuario autorizó tu aplicación
https://www.example.com/auth-callback
refresh_token
El token de actualización recibido cuando el usuario autorizó a tu aplicación
El nuevo token de acceso puede usarse para hacer llamadas en nombre del usuario. Cuando el nuevo token caduque, puedes seguir los mismos pasos nuevamente para generar uno nuevo.