Introducción

Inicio rápido

Esta guía cubre la ruta más rápida para realizar correctamente la primera llamada a la API V4 de Frame.io. Creará un proyecto en Adobe Developer Console, generará credenciales y realizará la primera solicitud de API.

Paso 1: Creación de un Project en Adobe Developer Console y adición de la API V4 de Frame.io

Desde Adobe Developer Console, cree un Project nuevo y añada la API V4 de Frame.io.

Esta guía utiliza OAuth 2.0 Web App para la autenticación. Para obtener información sobre otros métodos de autenticación, consulte la Guía de autenticación

Paso 2: Configuración de la aplicación

Seleccione OAuth Web App como tipo de aplicación y defina los campos de redirección.

URI de redireccionamientoRuta de la aplicación que recibe la respuesta OAuth de Adobe IMS. Una vez que un usuario inicia sesión y aprueba el acceso, Adobe IMS lo redirige a esta URL con un código de autorización en la cadena de consulta, que la aplicación intercambia por un token de acceso
Patrón de URI de redireccionamientoPatrones que coinciden con URL de redireccionamiento adicionales más allá del URI de redireccionamiento predeterminado. Esto resulta útil si la aplicación se ejecuta en varios entornos o utiliza enrutamiento dinámico. Se deben proporcionar varios patrones en una lista separada por comas

Paso 3: Autenticación

Inicie el flujo OAuth redirigiendo al usuario al punto final de autorización de Adobe IMS:

  https://ims-na1.adobelogin.com/ims/authorize/v2
  ?client_id={CLIENT_ID}
  &redirect_uri={REDIRECT_URI}
  &scope=offline_access,openid,email,profile,additional_info.roles
  &response_type=code

Cuando el usuario inicia sesión y aprueba el acceso, Adobe IMS lo redirige de vuelta al URI de redireccionamiento configurado con un código de autorización en la cadena de consulta. Intercambie ese código por un token de acceso enviando una solicitud POST al punto final de token de IMS.


A continuación, se incluye una lista de definiciones de parámetros junto con una solicitud y una respuesta de ejemplo:

ParámetroObligatorioDescripción
codeSíValor de la cadena de consulta code devuelto a redirect_uri cuando un usuario se autentica con la aplicación
grant_typeSíEl valor debe ser siempre authorization_code
authorizationObligatorio para clientes confidenciales
Ejemplo de solicitud
curl -X POST 'https://ims-na1.adobelogin.com/ims/token/v3' \
  -H 'Authorization: Basic {AUTHORIZATION}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'code={CODE}&grant_type=authorization_code'

Ejemplo de respuesta

{
    "access_token": "{ACCESS_TOKEN}",
    "refresh_token": "{REFRESH_TOKEN}",
    "sub": "B0DC108C5CD449CA0A494133@c62f24cc5b5b7e0e0a494004",
    "id_token": "{ID_TOKEN}",
    "token_type": "bearer",
    "expires_in": 86399
}
Compatibilidad con SDK

Tanto el SDK para Python como el SDK para TypeScript incluyen módulos de autenticación que gestionan el protocolo OAuth, el intercambio de tokens y la actualización automática de tokens. Puede obtener más información sobre cada uno aquí:

Python | TypeScript

Paso 4: Realización de las primeras solicitudes de API

Con el token de acceso, empiece llamando al punto final /v4/me:

curl https://api.frame.io/v4/me \
-H "Authorization: Bearer <token>"

Esta solicitud llama a la API de Adobe IMS para verificar el token y la información del usuario.

Una solicitud correcta devuelve detalles sobre el usuario autenticado, incluidos user_id, nombre y correo electrónico. Use esta solicitud para confirmar que el flujo de autenticación funciona según lo previsto.

La mayoría de los puntos finales de la API V4 requieren un account_id, que no devuelve /v4/me. Para obtener su account_id, realice una solicitud a /v4/accounts:

curl https://api.frame.io/v4/accounts \
-H "Authorization: Bearer <token>"

Esto devuelve la lista de cuentas disponibles para el usuario autenticado. Use el account_id de esta respuesta en solicitudes de API posteriores.

ID de usuario frente a ID de cuenta

user_id identifica al usuario como persona individual, mientras que account_id representa la organización a la que pertenece. La mayoría de los puntos finales V4 funcionan en el nivel de cuenta.

Próximos pasos

Con la autenticación configurada y account_id, ya puede empezar a trabajar con la API de Frame.io. Estos recursos pueden ayudarle a empezar: