Última modificación: 22 de agosto de 2025
Usa la API de tokens OAuth para generar y gestionar los tokens necesarios para autorizar tu aplicación pública y las solicitudes que realiza. Por ejemplo, deberás usar esta API para obtener los tokens de acceso inicial y de actualización durante el proceso de instalación de la aplicación. Luego la usarás para seguir generando nuevos tokens cuando caduquen los antiguos. Más información sobre cómo trabajar con OAuth.
Para poder usar estos endpoints, deberás crear una aplicación pública. Un usuario deberá instalarlo en su cuenta para iniciar el acceso con OAuth.
Iniciar el acceso con OAuth
Después de crear tu aplicación, un usuario puede instalarla en su cuenta de HubSpot usando la URL de instalación ubicada en la configuración de la aplicación, la cual incluiráclient_id
, redirect_uri
y scopes
como parámetros de consulta. También puedes incluir optional_scopes
y state
, si es necesario.
Después de que un usuario autorice tu aplicación y la instale en su cuenta, la URL de redireccionamiento se adjuntará con un valor code
, el cual puedes usar para generar un token de acceso y un token de actualización. El token de acceso se usará para autenticar las solicitudes que realice tu aplicación, mientras que el token de actualización se utilizará para obtener un nuevo token de acceso cuando caduque el actual.
Más información sobre cómo iniciar OAuth para tu aplicación.
Generar tokens de acceso inicial y de actualización
Para obtener acceso OAuth y actualizar tokens, realiza una solicitud codificadaPOST
de formulario URL a /oauth/v1/token
. En el cuerpo de la solicitud, especificarás varios parámetros de autenticación, como client_id
y client_secret
, junto con el code
devuelto a través de la URL de redireccionamiento.
Después de que un usuario autorice tu aplicación, la URL de redireccionamiento se adjuntará con un valor code
. Al usar este código, generarás el token de acceso inicial y el token de actualización. Los tokens de acceso son de corta duración y puedes consultar el parámetro expires_in
al generar un token de acceso para determinar su duración (en segundos).
Por ejemplo, el cuerpo de tu solicitud puede tener un aspecto similar al siguiente:
Parámetro | Tipo | Descripción |
---|---|---|
grant_type | Cadena | Debe ser authorization_code para que la solicitud genere tokens de acceso inicial y de actualización. |
code | Cadena | El code que se devuelve en la URL de redireccionamiento después de que el usuario instala la aplicación. |
redirect_uri | Cadena | La URL de redireccionamiento establecida de la aplicación. |
client_id | Cadena | El ID de cliente de la aplicación. |
client_secret | Cadena | El secreto del cliente de la aplicación. |
expires_in
especifica cuánto durará el token de acceso (en segundos).
Actualizar un token de acceso
Al usar un token de actualización, puedes generar un nuevo token de acceso realizando una solicitudPOST
codificada de formulario URL a /oauth/v1/token
. En el cuerpo de la solicitud, especificarás grant_type
, client_id
, client_secret
y refresh_token
.
Parámetro | Tipo | Descripción |
---|---|---|
grant_type | Cadena | Debe ser refresh_token para que la solicitud genere nuevos tokens de acceso a partir del token de actualización. |
refresh_token | Cadena | El valor del token de actualización. |
client_id | Cadena | El ID de cliente de la aplicación. |
client_secret | Cadena | El secreto del cliente de la aplicación. |
Recuperar metadatos del token de acceso
Para obtener información acerca de un token de acceso de OAuth, incluido el usuario para el que se creó el token y su Hub ID correspondiente, realiza una solicitudGET
a /oauth/v1/access-tokens/{token}
.
Recibirás una respuesta con información sobre el token de acceso del usuario y su cuenta de HubSpot.
Nota:
Se espera que los tokens de acceso de HubSpot fluctúen en tamaño a lo largo del tiempo, ya que se harán actualizaciones en la información que está codificada en ellos. Es recomendable permitir tokens de hasta 512 caracteres para contemplar posibles cambios.Eliminar un token de actualización
Si un usuario desinstala tu aplicación, puedes eliminar el token de actualización haciendo una solicitudDELETE
a /oauth/v1/refresh-tokens/{token}
. Esto solo eliminará el token de actualización. Los tokens de acceso generados con el token de actualización no serán eliminados. Además, esto no desinstalará la aplicación de las cuentas de HubSpot ni inhibirá la sincronización de datos entre la aplicación y la cuenta.