Введение

Быстрый старт

В этом руководстве описывается самый быстрый путь к первому успешному вызову API-интерфейса Frame.io V4. Вы создадите проект в Adobe Developer Console, сгенерируете учетные данные и выполните первый запрос к API-интерфейсу.

Шаг 1. Создание проекта в Adobe Developer Console и подключение API-интерфейса Frame.io V4

В Adobe Developer Console создайте новый проект и подключите API-интерфейс Frame.io V4.

В этом руководстве для аутентификации используется процесс веб-приложения OAuth 2.0. Подробнее о других методах аутентификации — в руководстве по аутентификации.

Шаг 2. Настройка приложения

Выберите веб-приложение OAuth в качестве типа приложения и настройте поля перенаправления.

URI перенаправленияМаршрут в приложении, на который приходит ответ OAuth от Adobe IMS. После того как пользователь выполнит вход и разрешит доступ, Adobe IMS перенаправляет его на этот URL-адрес, передав код авторизации в строке запроса. Затем приложение обменивает этот код на токен доступа.
Шаблон URL-адреса перенаправленияШаблоны, которые соответствуют дополнительным URL-адресам перенаправления, используемым в дополнение к URI перенаправления по умолчанию. Полезны, если приложение работает в нескольких средах или использует динамическую маршрутизацию. Несколько шаблонов необходимо указывать через запятую.

Шаг 3. Аутентификация

Запустите процесс OAuth, перенаправив пользователя на конечную точку авторизации 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

После того, как пользователь войдет в систему и подтвердит доступ, Adobe IMS перенаправит его обратно на настроенный вами URI перенаправления с кодом авторизации в строке запроса. Выполните обмен этого кода на токен доступа, отправив запрос POST на конечную точку токенов IMS.


Ниже приведен список параметров с определением, а также примеры запроса и ответа.

ПараметрОбязательныйОписание
codeДаЗначение параметра 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

SDK для Python и TypeScript включают модули аутентификации, которые берут на себя процедуру авторизации OAuth, обмен токенами и автоматическое обновление токенов. Подробнее о каждом из SDK:

Python | TypeScript

Шаг 4. Выполнение первых запросов к API-интерфейсу

Используйте токен доступа, чтобы вызвать конечную точку /v4/me.

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

Этот запрос обращается к API-интерфейсу Adobe IMS для проверки вашего токена и информации о пользователе.

Успешный запрос возвращает сведения об аутентифицированном пользователе, включая user_id, имя и адрес электронной почты. Используйте этот ответ, чтобы убедиться в корректной работе процесса аутентификации.

Большинство конечных точек API-интерфейса V4 требуют указания идентификатора account_id, который не возвращается методом /v4/me. Чтобы получить account_id, выполните запрос к /v4/accounts:

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

Этот метод возвращает список учетных записей, доступных аутентифицированному пользователю. Используйте account_id из этого ответа в последующих запросах к API-интерфейсу.

Разница между идентификаторами User ID и Account ID

Идентификатор user_id определяет вас как отдельного пользователя, в то время как account_id представляет организацию, к которой вы принадлежите. Большинство конечных точек V4 работают на уровне учетной записи.

Дальнейшие шаги

Настроив аутентификацию и получив account_id, вы готовы начать работу с API-интерфейсом Frame.io. Полезную информацию можно найти в следующих ресурсах.