CATA-SDK-EN
  1. Activation Process
CATA-SDK-EN
  • Documentation
    • AI Recognition Precautions
    • Quick Start
    • SDK Error Code
    • AI Sequence Diagram
    • Screen Cropping
    • API Documentation (C language)
  • Activation
    • Activation Process
      • Step 1: Activate the device
        POST
      • Step 2: Download device configuration
        POST
      • Step 3: Download device model
        POST
    • Activate information import/export
      • Export activation data
      • Import activation data
    • View Device Activation Information
      GET
  • Common interfaces
    • Retrieve camera images
      GET
    • Retrieve status
      GET
    • retrieve logs
      GET
    • retrieve config
      GET
  • Recognition
    • Screen cropping
      • Screen cropping
      • Screen cropping config
    • Recognition
      GET
    • feedback
      POST
    • learning forgetting
      POST
    • clear learning data
      POST
    • save learning
      POST
  • learning export & import
    • export
      GET
    • import
      POST
  • camera
    • Obtain the installed camera
    • Set up the camera
  • goods
    • import product data
  • Product Image Matching
    • Download image
    • Match image
    • Edit image
  1. Activation Process

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
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
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
Previous
API Documentation (C language)
Next
Step 2: Download device configuration
Built with