Key Registration
Key Details
AccessToken Issuance
Refresh Token
Get Building List
Get Floors in Building
Floor Info
Create Coordinates In Floor
Predict Positioning
Get Floor Coordinates

Key Registration

Registration API Key.

POST

/v1/key/regist

Request Body Schema

application/json

field type desc

key string API Key value to register

field	type	desc
key	string	API Key value to register

Response

Code: 200
Response Schema: application/json

{
    result: 
    {
        key_expired: long,        
        max_total_usage: int        
    }
}

Code: 400
Response Schema: application/json

{
    result: 
    {
        error: "Bad request"
    }
}

Code: 404
Response Schema: application/json

{
    result: 
    {
        error: "Not found"
    }
}

Code: 500
Response Schema: application/json

{
    result: 
    {
        error: "Internal server error"
    }
}

Key Details

API Key Details Status.

GET

/v1/key/detail

AUTHORIZATIONS

API Key

Response

Code: 200
Response Schema: application/json

{
    result: 
    {
        key_expired: long,
        remaining_total_usage: int,
        max_total_usage: int,
        scope: array<string>
    }
}

Code: 400
Response Schema: application/json

{
    result: 
    {
        error: "Bad request"
    }
}

Code: 404
Response Schema: application/json

{
    result: 
    {
        error: "Not found"
    }
}

Code: 500
Response Schema: application/json

{
    result: 
    {
        error: "Internal server error"
    }
}

AccessToken Issuance

Issuing Access Tokens Using API Keys.

GET

/v1/auth/token

AUTHORIZATIONS

API Key

Response

Code: 200
Response Schema: application/json

{
    result: 
    {
        key_expired: long,
        access_token: string,
    }
}

Code: 400
Response Schema: application/json

{
    result: 
    {
        error: "Bad request"
    }
}

Code: 404
Response Schema: application/json

{
    result: 
    {
        error: "Not found"
    }
}

Code: 429
Response Schema: application/json

{
    result: 
    {
        error: "This token is not authenticated."
    }
}

Code: 500
Response Schema: application/json

{
    result: 
    {
        error: "Internal server error"
    }
}

Refresh Token

Renewing AccessToken

GET

/v1/auth/refresh

AUTHORIZATIONS

Access Token

Response

Code: 200
Response Schema: application/json

{
    result: 
    {
        key_expired: long,
        access_token: string,
    }
}

Code: 400
Response Schema: application/json

{
    result: 
    {
        error: "Bad request"
    }
}

Code: 404
Response Schema: application/json

{
    result: 
    {
        error: "Not found"
    }
}

Code: 429
Response Schema: application/json

{
    result: 
    {
        error: "This token is not authenticated."
    }
}

Code: 500
Response Schema: application/json

{
    result: 
    {
        error: "Internal server error"
    }
}

Get Building List

Print only the basic information of all buildings under management.

GET

/v1/building/list

AUTHORIZATIONS

Access Token

Response

Code: 200
Response Schema: application/json

[
    {
        building_id:"string",
        building_name:"string"
    }
]

Code: 400
Response Schema: application/json

{
    result: 
    {
        error: "Bad request"
    }
}

Code: 404
Response Schema: application/json

{
    result: 
    {
        error: "Not found"
    }
}

Code: 429
Response Schema: application/json

{
    result: 
    {
        error: "This token is not authenticated."
    }
}

Code: 500
Response Schema: application/json

{
    result: 
    {
        error: "Internal server error"
    }
}

Get Floors in Building

A function that prints only the basic information of all floors belonging to a specific building.

GET

/v1/building/floor/list

AUTHORIZATIONS

Access Token

Query

building_id

Response

Code: 200
Response Schema: application/json

[
    {
        floor_id:"string",
        floor_name:"string"
    }
]

Code: 400
Response Schema: application/json

{
    result: 
    {
        error: "Bad request"
    }
}

Code: 404
Response Schema: application/json

{
    result: 
    {
        error: "Not found"
    }
}

Code: 429
Response Schema: application/json

{
    result: 
    {
        error: "This token is not authenticated."
    }
}

Code: 500
Response Schema: application/json

{
    result: 
    {
        error: "Internal server error"
    }
}

Floor Info

Function to output detailed information on a specific layer

GET

/v1/floor/info

AUTHORIZATIONS

Access Token

Query

floor_id

Response

Code: 200
Response Schema: application/json

{
    floor_id:"string",
    floor_name:"string"
    floor_img:"string",
    floor_x_by_meter:"float",
    floor_y_by_meter:"float",
    floor_number:"int",
    floor_is_basement:"boolean",
    floor_created:"string"
}

Code: 400
Response Schema: application/json

{
    result: 
    {
        error: "Bad request"
    }
}

Code: 404
Response Schema: application/json

{
    result: 
    {
        error: "Not found"
    }
}

Code: 429
Response Schema: application/json

{
    result: 
    {
        error: "This token is not authenticated."
    }
}

Code: 500
Response Schema: application/json

{
    result: 
    {
        error: "Internal server error"
    }
}

Create Coordinates In Floor

POST

/v1/floor/coordinates

AUTHORIZATIONS

Access Token

Request Body Schema

application/json

field type desc

floor_id string Target floor’s Unique ID

x float X coordinate (pixel)

y float Y coordinate (pixel)

time long Unix timestamp

field	type	desc
floor_id	string	Target floor’s Unique ID
x	float	X coordinate (pixel)
y	float	Y coordinate (pixel)
time	long	Unix timestamp

Response

Code: 200
Response Schema: application/json

{
    result:
    {
        success: "Coordinates Created"
    }
}

Code: 400
Response Schema: application/json

{
    result: 
    {
        error: "Bad request"
    }
}

Code: 404
Response Schema: application/json

{
    result: 
    {
        error: "Not found"
    }
}

Code: 429
Response Schema: application/json

{
    result: 
    {
        error: "This token is not authenticated."
    }
}

Code: 500
Response Schema: application/json

{
    result: 
    {
        error: "Coordinates failed: {Error Message}"
    }
}

Predict Positioning

POST

/v1/device/Predict

AUTHORIZATIONS

Access Token

Request Body Schema

application/json

field type desc

bssid string device’s Unique ID

rssi map<string, int> Key-value pairs of WiFi MAC addresses and rssi signals scanned by the Device

field	type	desc
bssid	string	device’s Unique ID
rssi	map<string, int>	Key-value pairs of WiFi MAC addresses and rssi signals scanned by the Device

Response

Code: 200
Response Schema: application/json

{
    result:
    {
        success: "Positioning Created"
    }
}

Code: 400
Response Schema: application/json

{
    result: 
    {
        error: "Bad request"
    }
}

Code: 404
Response Schema: application/json

{
    result: 
    {
        error: "Not found"
    }
}

Code: 429
Response Schema: application/json

{
    result: 
    {
        error: "This token is not authenticated."
    }
}

Code: 500
Response Schema: application/json

{
    result: 
    {
        error: "Positioning Predict failed: {Error Message}"
    }
}

Get Floor Coordinates

GET

/v1/floor/coordinates

AUTHORIZATIONS

Access Token

Query

floor_id

time

Response

Code: 200
Response Schema: application/json

[
    {
        asset_id: "string",
        asset_name: "string",
        asset_x: "double",
        asset_y: "double",
        timestamp: "long"
    }   
]

Code: 400
Response Schema: application/json

{
    result: 
    {
        error: "Bad request"
    }
}

Code: 404
Response Schema: application/json

{
    result: 
    {
        error: "Not found"
    }
}

Code: 429
Response Schema: application/json

{
    result: 
    {
        error: "This token is not authenticated."
    }
}

Code: 500
Response Schema: application/json

{
    result: 
    {
        error: "Internal server error"
    }
}