API ReferenceAutenticacao

Solicitar código do dispositivo

Cabeçalhos

x-client-versionstringOpcionalPadrão é 0.0.0
Firmware or software version of a C2C integration. Will be used to determine the correct Device Model configuration for the device when multiple are available. Must be a valid semantic version. For more on semantic versions, see here: https://semver.org/
x-client-platypus-enabledenumOpcional
Enable URL Pairing mode for C2C device code requests. Set to 'true' to enable.
Valores permitidos:

Solicitação

client_idstringObrigatório

Um identificador exclusivo para o dispositivo físico de hardware. Esse valor precisa ter unicidade garantida para o dispositivo. Pode ser um número de série ou um UUID gerado aleatoriamente.

client_secretstringObrigatório

Isso será emitido a você pelo suporte do Frame.io e identifica o modelo do seu dispositivo. Esse valor deve ser mantido em sigilo do usuário e deve ser criptografado em repouso

scopestringObrigatórioformat: "asset_create offline"

Lista delimitada por espaços das permissões que estão sendo solicitadas. Dispositivos de hardware podem solicitar os seguintes escopos: ‘asset_create’ (criar ativos), ‘offline’ (tokens de atualização).

Resposta

Solicitação bem-sucedida

device_codestring>=1 character
The device code should be hidden from the user, and is used to identify this authorization request when polling to see if the user has entered their code successfully.
expires_indouble<=120
The number of seconds until this code expires.
intervaldouble
How long the we should wait between polling requests to see if the user has entered the code.
namestring>=1 character
The name of the device we are trying to connect.
user_codestring>=1 character

The six-digit code the user will enter into Frame.io to pair the device to a project.

verification_uristringformat: "uri"
The URL where the user should go to enter the pairing code.
verification_uri_completestringOpcionalformat: "uri"

A complete URL with the user code pre-filled, which can be used to streamline the pairing process.