OAuth es un método seguro de autenticación para tu aplicación. Utiliza tokens de autorización en lugar de una contraseña para conectar tu aplicación a una cuenta de usuario.
/oauth/
y /authorize
, como se muestra a continuación. Después de permitir el acceso, se redireccionarán a tu aplicación mediante una redirect_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.
https://app.hubspot.com/oauth/authorize?client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&scope=contacts%20automation&redirect_uri=https://www.example.com/
https://app.hubspot.com/oauth/123456/authorize?client_id=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx&scope=contacts%20automation&redirect_uri=https://www.example.com/
https://example.com/?code=xxxx
https://www.example.com/?error=error_code&error_description=Human%20readable%20description%20of%20the%20error
access_token
para autenticar las llamadas a la API realizadas a esa cuenta de HubSpot.
access_token
, usa el refresh_token
para generar un nuevo access_token
.
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.Parámetro | Descripción | Cómo se usa |
---|---|---|
client_id | Un ID que sirve como identificador único para tu aplicación. | Obténlo desde la página de configuración de autorización o “Auth” de tu aplicación (como se ha descrito anteriormente). |
redirect_uri | La URL a la que serán redireccionados los visitantes al recibir acceso a la aplicación. | También designarás esto en la página de configuración de autenticación de tu aplicación. Nota: Por razones de seguridad, esta URL debe utilizar https en producción. (Si realizas la prueba con localhost , puedes utilizar http .) También debes usar un dominio, ya que las direcciones IP no son compatibles. |
scope | Un conjunto de permisos separados por espacios a los que tu aplicación necesita acceder. | Todos los permisos que hayas marcado en la configuración de Autenticación de la aplicación se tratarán como obligatorios, por lo que deberás incluirlos en este parámetro. De lo contrario, la página de autorización mostrará un error. Además, los usuarios recibirán un error si intentan instalar tu aplicación en una cuenta que no tiene acceso a un permiso incluido. Ve la documentación de referencia de permisos para conocer más detalles sobre los endpoints que pueden tener permisos específicos. |
Parámetro | Cómo usar | Descripción |
---|---|---|
optional_scope | Un conjunto separado por espacios de permisos opcionales para tu aplicación. | Los permisos opcionales se eliminarán automáticamente de la solicitud de autorización si el usuario selecciona una cuenta de HubSpot que no tiene acceso a esa herramienta (por ejemplo, autorizar el acceso a Content Hub Enterprise en una cuenta gratuita de HubSpot). Si estás usando permisos opcionales, deberás verificar el token de acceso o el token de actualización para ver cuáles se otorgaron. Consulta la documentación de referencia sobre permisos para obtener más detalles. |
state | Si este parámetro está incluido en la URL de autorización, el valor se incluirá en un parámetro de consulta de estado cuando el usuario sea dirigido a redirect_uri . | Un valor de cadena que se puede usar para mantener el estado del usuario cuando se redirecciona de regreso a la aplicación. |
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í.