Cloud Web API
MAXST Developer site RESTful API for cloud services
Authorization
Add the following value to the Request Header
Authorization: Token {User-generated token}
- Token Structure : JSON Web Token (JWT)
The JWT payload contains iat (valid for 30 minutes) and secId.
JWT Algorithm : HS256
iat : current unix timestamp
sec Id(SEC ID), secret(SEC KEY) can be checked by clicking the "Access Keys" button in the group of "Target Manager - Cloud".
Reference :
Sample :
- secId : "abcde"
- secret : "secret"
- iat : 1513732932 (2017-12-20T01:22:12+00:00)
- Authorization: Token eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpYXQiOjE1MTM3MzI5MzIsInNlY0lkIjoiYWJjZGUifQ.Y9vYPKT7qy_B3Y3aOl5gaRBEZHH5J5i5RUcoEtGv-4Y
Content Type
Content-Type: application/json; charset=utf-8
Create Target
Create a target within an authenticated group
Protocol | Method | Additional URLs |
---|---|---|
https | POST | /api/Trackables |
Request Body Param :
Name | Type | Required | Description |
---|---|---|---|
Name | string | true | Up to 20 characters consisting only of alphanumeric characters shall be allowed. No duplication is allowed in the group. |
UploadFile | string | true | This is the image you are uploading; base64 format byte array (3MB or less) JPG, PNG (32-bit PNG is not supported). |
RealWidth | float | true | This is represented in meters (30 cm = 0.3). |
OriginalFileName | string | The original file name of the image shall be uploaded | |
Custom | string | The custom data for customization. When successfully recognized, it will also be included in the results. (JSON format recommended) |
Response Body :
Name | Type | Description |
---|---|---|
Id | string | ID |
CreateDT | Datetime | Created Date |
UpdateDT | Datetime | Updated Date |
Name | string | |
RealWidth | float | |
OriginalFileName | string | |
Custom | string | |
WorkStatus | string | Learning status(standby, ing, complete, fail) |
LastClLearnQuality | float | Learning quality for recognition (0 ~ 5) |
ImgId | string | UUID to identify the image |
Update Target
Edit target for id. Anything that is null or undefined is unmodified.
Protocol | Method | Additional URLs |
---|---|---|
https | PUT | /api/Trackables/{Id} |
Request Body Param :
Name | Type | Required | Description |
---|---|---|---|
Name | string | true | Up to 20 characters consisting only of alphanumeric characters shall be allowed. No duplication is allowed in the group. |
RealWidth | float | true | This is represented in meters. (30 cm = 0.3) |
Custom | string | The custom data for customization. When successfully recognized, it will also be included in the result. (JSON format recommended) |
Response Body :
Name | Type | Description |
---|---|---|
Id | string | ID |
CreateDT | Datetime | Created Date |
UpdateDT | Datetime | Updated Date |
Name | string | |
RealWidth | float | |
OriginalFileName | string | |
Custom | string | |
WorkStatus | string | Learning status(standby, ing, complete, fail) |
LastClLearnQuality | float | Learning quality for recognition (0 ~ 5) |
ImgId | string | UUID to identify the image |
Delete Target
Delete target for id.
Protocol | Method | Additional URLs |
---|---|---|
https | DELETE | /api/Trackables/{Id} |
Request Body Param :
Name | Type | Required | Description |
---|---|---|---|
Response Body :
Name | Type | Description |
---|---|---|
Id | string | ID |
Get Target
Get target for ID.
Protocol | Method | Additional URLs |
---|---|---|
https | GET | /api/Trackables/{Id} |
Request Body Param :
Name | Type | Required | Description |
---|---|---|---|
Response Body :
Name | Type | Description |
---|---|---|
Id | string | ID |
CreateDT | Datetime | Created Date |
UpdateDT | Datetime | Updated Date |
Name | string | |
RealWidth | float | |
OriginalFileName | string | |
Custom | string | |
WorkStatus | string | Learning status(standby, ing, complete, fail) |
LastClLearnQuality | float | Learning quality for recognition (0 ~ 5) |
ImgId | string | UUID to identify the image |
Get Target List
Get a list of targets within an authenticated group
Protocol | Method | Additional URLs |
---|---|---|
https | GET | /api/Trackables |
Request Body Param :
Name | Type | Required | Description |
---|---|---|---|
Response Body :
Name | Type | Description |
---|---|---|
array | targets |
Get Target Group
Get a information about authenticated groups
Protocol | Method | Additional URLs |
---|---|---|
https | GET | /api/TrackableGroupInfo |
Request Body Param :
Name | Type | Required | Description |
---|---|---|---|
Response Body :
Name | Type | Description |
---|---|---|
Id | string | ID |
CreateDT | Datetime | Created Date |
UpdateDT | Datetime | Updated Date |
Name | string | Group Name |
TrackableCnt | int | Targets Count |
LicenseId | string | Refrenced license id |
LicenseName | string | License Name |
RecogCnt | int | Recognition Count |
RecogQuota | int | Recognition Quota |
TrackableQuota | int | Targets Quota |
ReqVs | array | Versions available for recognition request |