前言

快速开始

本指南介绍了成功进行首次 Frame.io V4 API 调用的最快路径。 您将在 Adobe Developer Console 中创建一个项目，生成凭据，然后进行首次 API 请求。

步骤 1：在 Adobe Developer Console 中创建项目 + 添加 Frame.io V4 API

从 Adobe Developer Console 中创建新项目，并添加 Frame.io V4 API。

本指南使用 OAuth 2.0 Web 应用程序进行身份验证。有关其他身份验证方法的信息，请参阅**身份验证指南**

步骤 2：配置您的应用程序

选择 OAuth Web 应用程序作为您的应用程序类型，并设置您的重定向字段。

重定向 URI您的应用程序中用于接收来自 Adobe IMS 的 OAuth 响应的路由。用户登录并批准访问后，Adobe IMS 会将他们重定向到此 URL，并在查询字符串中附带一个授权码，随后您的应用程序会将该授权码交换为访问令牌
重定向 URI 模式用于匹配除默认重定向 URI 之外的其他重定向 URL 的模式。如果您的应用程序在多个环境中运行或使用动态路由，这会非常有用。多个模式应以逗号分隔的列表形式提供

步骤 3：身份验证

通过将用户重定向到 Adobe IMS 授权端点来启动 OAuth 流：

  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

在用户登录并批准访问后，Adobe IMS 会将其重定向回您配置的重定向 URI，并在查询字符串中附上授权码。 通过向 IMS 令牌端点发送 POST 请求来交换该代码，获取访问令牌。


以下是参数定义列表以及示例请求和响应：

参数必填描述
code是当用户通过您的应用程序进行身份验证时返回到您的 redirect_uri 的代码查询字符串的值
grant_type是值应始终为 authorization_code
authorization机密客户端需要的内容
示例请求
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'

示例响应

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

Python 和 TypeScript SDK 均包含身份验证模块，用于处理 OAuth 握手、令牌交换和自动令牌刷新。 您可以在此处找到有关每项的更多信息：

Python | TypeScript

步骤 4：发出您的第一个 API 请求

使用您的访问令牌，首先调用 /v4/me 端点：

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

此请求会调用 Adobe IMS API 以验证您的令牌和用户信息。

成功的请求会返回已验证用户的详细信息，其中包括 user_id、姓名和电子邮件地址。使用此请求确认您的身份验证流是否正常运行。

大多数 V4 API 端点都需要 account_id，但 /v4/me 不会返回此信息。要获取您的 account_id，请向 /v4/accounts 发出请求：

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

这会返回经过身份验证的用户可用的帐户列表。 在后续 API 请求中使用此响应中的 account_id。

用户 ID 与帐户 ID

您的 user_id 可以标识您的个人身份，而您的 account_id 则代表您所属的组织。 大多数 V4 端点都在帐户级别运行。

后续步骤

完成身份验证并有了您的 account_id 后，您就可以开始使用 Frame.io API 了。 这些资源可以帮助您开始使用：