Recursos recomendados
- La guía de inicio de OAuth te ayudará a comenzar con una aplicación de ejemplo.
- Este tutorial de HubSpot Academy ofrece una introducción rápida en el uso de OAuth con HubSpot, incluyendo un desglose del flujo de HubSpot a OAuth y cómo actualizar un token de acceso.
Configurar la autenticación OAuth
Para configurar la autenticación OAuth para tu aplicación:- En primer lugar, crea una aplicación en una cuenta de desarrollador de HubSpot. Después de crear la aplicación, podrás encontrar el ID de cliente de la aplicación y el secreto del cliente en la página de autenticación de la configuración de tu aplicación.
- Usa el ID de cliente y el secreto del cliente, junto con los parámetros de consulta y los permisos que se describen a continuación, para crear la URL de autorización.
-
Envía a los usuarios que deseen instalar la aplicación la URL de autorización, donde tendrán una pantalla que les permitirá seleccionar su cuenta y acceder a la integración. Puedes establecer que la URL de autorización sea para una cuenta de HubSpot específica agregando el ID de cuenta entre
/oauth/y/authorize, como se muestra a continuación. Después de permitir el acceso, se redireccionarán a tu aplicación mediante unaredirect_url, que tendrá un parámetro adjunto de consulta de código. Usarás ese código y el secreto del cliente para obtener un access_token y refresh_token de HubSpot.- Ejemplos de URL de autorización
- Cualquier cuenta:
https://app.hubspot.com/oauth/authorize?client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&scope=contacts%20automation&redirect_uri=https://www.example.com/ - Cuenta específica (ID 123456):
https://app.hubspot.com/oauth/123456/authorize?client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&scope=contacts%20automation&redirect_uri=https://www.example.com/
- Cualquier cuenta:
- Ejemplo de URL de redireccionamiento:
https://example.com/?code=xxxx - Ejemplo de error:
https://www.example.com/?error=error_code&error_description=Human%20readable%20description%20of%20the%20error
- Ejemplos de URL de autorización
-
Usa el
access_tokenpara autenticar las llamadas a la API realizadas a esa cuenta de HubSpot. -
Una vez que expire el
access_token, usa elrefresh_tokenpara generar un nuevoaccess_token.
Parámetros de consulta
Los siguientes parámetros de solicitud son obligatorios al crear una URL de autorización para tu aplicación:
Los siguientes parámetros son opcionales:
Configurar permisos
OAuth requiere que configures permisos o alcances, para tu aplicación. Cada permiso proporciona acceso a un conjunto de endpoints de la API de HubSpot y permite a los usuarios otorgar a la aplicación acceso a herramientas específicas en su cuenta de HubSpot.
optional_scope para incluir los permisos con los que trabajas. De esta manera, los clientes que usan las cuentas gratuitas de HubSpot aún pueden autorizar la aplicación, incluso si no pueden acceder a todos los permisos. La aplicación debe verificar y manejar cualquier permiso para el que no esté autorizada.
La lista completa de permisos está disponible aquí.