API Reference身份验证

请求设备代码

请求头

x-client-versionstring可选默认为 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-enabledenum可选
Enable URL Pairing mode for C2C device code requests. Set to 'true' to enable.
允许的值:

请求

client_idstring必需

物理硬件设备的唯一标识符。该值需要保证对设备唯一。可以是序列号或随机生成的 UUID。

client_secretstring必需

此值将由 Frame.io 支持团队颁发给您，用于标识您的设备型号。该值应对用户保密，并应在静态存储时进行加密

scopestring必需格式: "asset_create offline"

以空格分隔的所请求权限列表。硬件设备可以请求以下范围：‘asset_create’（创建资产），‘offline’（刷新令牌）。通常会同时请求这两项。

响应

请求成功

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_uristring格式: "uri"
The URL where the user should go to enter the pairing code.
verification_uri_completestring可选格式: "uri"

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