Аутентификация

Обзор

Для выполнения вызовов API с помощью API-интерфейса Frame.io требуется аутентификация. API-интерфейс Frame.io предлагает два варианта аутентификации.

• Токены разработчика: постоянный токен Bearer, который имеет те же права доступа и разрешения, что и отдельный пользователь, который его создал.
• Поток кода авторизации OAuth 2, который позволяет пользователям Frame.io войти в систему со своими учетными данными и предоставлять внешнему приложению разрешение действовать от их имени.

Все действия с использованием API-интерфейса, независимо от выбранного для их выполнения типа аутентификации, в конечном итоге используют заголовки токенов Bearer и контролируются областями доступа.

Какой тип аутентификации лучше всего подходит для моего проекта?

В начале работы для вашего проекта лучше использовать токен разработчика. Токены разработчика связаны с учетной записью отдельного пользователя, имеют те же разрешения доступа, что и пользователь, который их создал, и ограничены областями доступа.

Они отлично подходят для следующего:

• экспериментов (их можно создавать и удалять очень быстро);
• сценариев интеграции, где все действия могут выполняться в контексте одной учетной записи/одного пользователя.

Поток кода OAuth подходит для внешних приложений, которым необходимо действовать от имени нескольких пользователей. Управление токенами Bearer с помощью OAuth требует немного больше усилий, поэтому нередко сначала экспериментируют с токеном разработчика, а затем перерабатывают в приложение OAuth.

Токены разработчика

1. Войдите на Developer Portal Frame.io с помощью ваших учетных данных пользователя Frame.io.
2. Отобразится экран приветствия. Чтобы cоздать новый токен разработчика, нажмите кнопку Create a Token.
3. Появится экран токенов. Нажмите New.
4. На экране нового токена необходимо указать описание и области доступа для вашего токена. Для DESCRIPTION мы рекомендуем указывать то, что напоминает, для чего применяется этот токен. В разделе SCOPES можно выбрать области доступа для этого токена. Просто нажмите Select all scopes. При необходимости можно создать токены с более конкретными разрешениями и правами доступа позже (подробнее см. в Области доступа).
5. Прокрутите вниз и нажмите кнопку Create. Отобразится страница со сводной информацией о вашем токене.
6. Скопируйте строку в поле Token. Это ваш новый токен. Сохраните его в надежном месте — он предоставляет доступ к вашей учетной записи, и после того как вы покинете эту страницу, вы больше не сможете его увидеть.

На данном этапе вы получите электронное письмо, в котором подтверждается создание токена с выбранными областями доступа.

Тестирование нового токена

Теперь, когда у вас есть токен, попробуйте выполнить запрос с использованием аутентификации Bearer. Выполним базовый запрос для получения информации о себе:

$
curl -H "Authorization: Bearer <YOUR_TOKEN>" https://api.frame.io/v2/me

В ответ вы увидите JSON-представление вашей записи пользователя.

Поздравляем! Вы только что выполнили свой первый вызов к API-интерфейсу Frame.io. 🎉

Что такое OAuth 2?

OAuth2.0 — это распространенный протокол аутентификации, который позволяет пользователю разрешить одному приложению ограниченно взаимодействовать с другим без прямого совместного использования учетных данных. Этот процесс обычно называется «предоставление учетных данных» пользователем с помощью специального экрана входа.

Поток кода авторизации OAuth 2

Поток кода авторизации OAuth 2 позволяет пользователям предоставлять ограниченный доступ внешним приложениям. Приложение запрашивает определенные разрешения на основе своей первоначальной конфигурации — в случае Frame.io, когда приложение зарегистрировано на нашем Developer Portal. Пользователь утверждает запрос, после чего внешнее приложение может выполнять действия от имени этого пользователя. Узнайте, как начать работу с потоком кода авторизации OAuth 2 здесь: Настройка потока кода аутентификации OAuth 2

Подробнее об OAuth 2

Если вы хотите узнать больше об OAuth 2, вот несколько отличных ресурсов:

• OAuth2
• Поток кода авторизации