Step 1: Activate the device

POST

/register

Request

Body Params application/json

passphrase

string

required

passphrase

trailDays

integer

required

trial days

Example

{
    "passphrase": "passphrase text",
    "trailDays": 30
}

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'http://localhost:17339/register' \
--header 'Content-Type: application/json' \
--data-raw '{
    "passphrase": "passphrase text",
    "trailDays": 30
}'

Responses

🟢200success

application/json

Body

deviceSerial

string

required

example：0815:B031:2724

deviceId

string

required

example：NBrjC7AWQEi7GQWF4VsuAA

remoteAccessed

boolean

required

example：true

remoteValidation

boolean

required

example：true

trial

boolean

required

example：false

errorCode

integer

required

example：0

Example

{
    "deviceSerial": "0815:B031:2724",
    "deviceId": "NBrjC7AWQEi7GQWF4VsuAA",
    "remoteAccessed": true,
    "remoteValidation": true,
    "trial": false,
    "errorCode": 0
}

🟢200error

Modified at 2025-02-11 08:05:32

API Documentation (C language)

Step 2: Download device configuration