API ReferenceAuthentifizierung

Endgerätecode anfordern

Header

x-client-versionstringOptionalStandardwert ist 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-enabledenumOptional
Enable URL Pairing mode for C2C device code requests. Set to 'true' to enable.
Erlaubte Werte:

Anfrage

client_idstringErforderlich

Eine eindeutige Identifizierung für das physische Hardware-Gerät. Dieser Wert muss für das Gerät garantiert eindeutig sein. Das kann eine Seriennummer oder eine zufällig generierte UUID sein.

client_secretstringErforderlich

Dieser wird vom Frame.io-Support ausgestellt und identifiziert Ihr Gerätemodell. Dieser Wert sollte vor dem bzw. der Benutzenden geheim gehalten und im Ruhezustand verschlüsselt werden

scopestringErforderlichFormat: "asset_create offline"

Durch Leerzeichen getrennte Liste der angeforderten Berechtigungen. Hardwaregeräte können die folgenden Geltungsbereiche anfordern: „asset_create“ (Assets erstellen), „offline“ (Token aktualisieren). Normalerweise werden beide zusammen angefordert.

Antwort

Anfrage erfolgreich
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_completestringOptionalFormat: "uri"

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