Introdução

Início rápido

Este guia aborda o caminho mais rápido para sua primeira chamada bem-sucedida à API Frame.io V4. Você criará um projeto no Adobe Developer Console, gerará credenciais e fará sua primeira solicitação de API.

Etapa 1: criar um Projeto no Adobe Developer Console e adicionar a API Frame.io V4

No Adobe Developer Console, crie um novo projeto e adicione a API Frame.io V4.

Este guia usa OAuth 2.0 Web App para autenticação.Para informações sobre outros métodos de autenticação, consulte o Guia de autenticação

Etapa 2: configurar o aplicativo

Selecione OAuth Web App como tipo de aplicativo e defina os campos de redirecionamento.

URI de redirecionamentoUma rota no aplicativo que recebe a resposta OAuth do Adobe IMS.Depois que um usuário faz logon e aprova o acesso, o Adobe IMS o redireciona para esse URL com um código de autorização na string de consulta, que o aplicativo troca por um token de acesso
Padrão de URI de redirecionamentoPadrões que correspondem a URLs de redirecionamento adicionais além do URI de redirecionamento padrão.Isso é útil se o aplicativo é executado em vários ambientes ou usa roteamento dinâmico.Vários padrões devem ser fornecidos como uma lista separada por vírgulas

Etapa 3: autenticação

Inicie o fluxo OAuth redirecionando o usuário para o ponto de acesso de autorização do 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

Depois que o usuário fizer logon e aprovar o acesso, o Adobe IMS o redirecionará de volta para a URI de redirecionamento configurada com um código de autorização na string de consulta. Troque esse código por um token de acesso enviando uma solicitação POST ao ponto de acesso de token do IMS.


Veja uma lista de definições de parâmetros junto com um exemplo de solicitação e resposta:

ParâmetroObrigatórioDescrição
codeSimO valor da string de consulta code retornado para seu redirect_uri quando um usuário se autentica com o aplicativo
grant_typeSimO valor deve sempre ser authorization_code
authorizationObrigatório para clientes confidenciais
Exemplo de solicitação
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'

Exemplo de resposta

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

Os SDKs para Python e TypeScript incluem módulos de autenticação que processam o handshake OAuth, a troca de token e a atualização automática de token. Você pode encontrar mais informações sobre cada um aqui:

Python | TypeScript

Etapa 4: fazer suas primeiras solicitações de API

Com o token de acesso, comece chamando o ponto de acesso /v4/me:

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

Esta solicitação chama a API do Adobe IMS para verificar seu token e suas informações de usuário.

Uma solicitação bem-sucedida retorna detalhes sobre o usuário autenticado, incluindo user_id, nome e e-mail. Use isso para confirmar que o fluxo de autenticação está funcionando conforme esperado.

A maioria dos pontos de acesso da API V4 exige um account_id, que não é retornado por /v4/me. Para obter seu account_id, faça uma solicitação para /v4/accounts:

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

Isso retorna a lista de contas disponíveis para o usuário autenticado. Use o account_id dessa resposta em solicitações de API subsequentes.

ID de usuário vs ID de conta

Seu user_id identifica você como pessoa, e seu account_id representa a organização à qual você pertence. A maioria dos pontos de acesso V4 opera no nível da conta.

Próximas etapas

Com a autenticação configurada e seu account_id, você está pronto para começar a trabalhar com a API do Frame.io. Estes recursos podem ajudar você a começar: