Vai alla navigazione
API ReferenceAutenticazione

Richiedi codice del dispositivo

Header

x-client-versionstringOpzionalePredefinito a 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-enabledenumOpzionale
Enable URL Pairing mode for C2C device code requests. Set to 'true' to enable.
Valori consentiti:

Richiesta

This endpoint expects a multipart form.
client_idstringObbligatorio

Un identificatore univoco per il dispositivo hardware fisico. Questo valore deve garantire l’univocità del dispositivo. Può essere un numero di serie o un UUID generato in modo casuale.

client_secretstringObbligatorio

Verrà inviato dall'assistenza Frame.io e identifica il modello del dispositivo. Non svelare questo valore all’utente e criptalo at-rest

scopestringObbligatorioformat: "asset_create offline"

Elenco di autorizzazioni richieste, delimitato da spazi. I dispositivi hardware possono richiedere i seguenti ambiti: ‘asset_create’ (crea risorse), ‘offline’ (aggiorna token). In genere, vengono richiesti insieme.

Risposta

Richiesta completata
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_completestringOpzionaleformat: "uri"

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