API ReferenceAuthentification

Demander un code d’appareil

En-têtes

x-client-versionstringOptionnelPar défaut 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-enabledenumOptionnel
Enable URL Pairing mode for C2C device code requests. Set to 'true' to enable.
Valeurs autorisées:

Requête

client_idstringRequis

Identifiant unique de l’appareil physique. Cette valeur doit être unique pour l’appareil. Il peut s’agir d’un numéro de série ou d’un UUID généré aléatoirement.

client_secretstringRequis

Émise par l’assistance Frame.io, cette valeur identifie le modèle de votre appareil. Elle doit rester secrète pour l’utilisateur et être chiffrée au repos.

scopestringRequisformat: "asset_create offline"

Liste des autorisations demandées, délimitée par des espaces. Les appareils physiques peuvent requérir les portées suivantes : ‘asset_create’ (créer des assets), ‘offline’ (actualiser les jetons). En général, les deux sont demandées ensemble.

Réponse

Requête réussie

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_completestringformat: "uri"

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