REST API

List of all the APIs used to interact with the ARwayKit Cloud Service.

get
List all Created Maps

https://api.arway.app/map-api/maps_list/
Get a list of all the created Maps from Developer Portal
Request
Response
Request
Headers
dev-token
required
string
Your developer token can be found on developer.arway.app
Response
200: OK
JSON response for maps_list
{
"map_list": [{
"map_id": "MAP Id",
"map_name": "Map name",
"map_image": "<Image_URL>",
"map_address": "<Location_String>",
"map_location": {
"latitude": "xx.xxxxx",
"longitude": "yy.yyyyy"
}
}]
}

get
Get Map data

https://api.arway.app/map-api/map_data/?<map_id>
Get the map data using map_id
Request
Response
Request
Path Parameters
map_id
required
string
ID of the map to fetch map data.
Headers
dev-token
required
string
Your developer token can be found on developer.arway.app
Response
200: OK
JSON response for map_data
{
"Waypoints": [],
"Destinations": [],
"FloorPlans": [],
"FloorImages": [],
"GlbModels": [],
"Texts": []
}

get
Get Cloud List

https://api.arway.app/map-api/cloud_list/
Get a list of all the point cloud maps created using the ARWAY Mapping app or Scene
Request
Response
Request
Headers
dev-token
required
string
Your developer token can be found on developer.arway.app
Response
200: OK
JSON response for cloud_list
{
"cloudMapList": [{
"id": String,
"map_name": String,
"binary_link": String,
"pcd_link": String,
"uploaded": String Date,
"AnchorId": String,
"Latitude": String,
"Longitude": String
}]
}

get
Request Pose - Deprecated

https://localization.arway.app/<dev-token>/req_pose
Get the device pose by passing the image data as a jpeg/png base64 string
Request
Response
Request
Headers
dev-token
required
string
Your developer token can be found on developer.arway.app
Body Parameters
JSON body
required
object
Send JSON object in body parameter as shown below
Response
200: OK
JSON response for req_pose
{
"setparam": true,
"poseAvailable": true,
"counter": localizationCounter,
"pose": "poseArray"[R00,R01,R02,PX,R10,R11,R12,PY,R20,R21,R22,PZ]
"Cloud_Id": 345 (map which was localized)
}

Example of JSON Body data to be sent during request

{
"cloud_Ids": Int List of<cloud_id>,
"width": Int Image_width,
"height": Int Image_height,
"channel": Int 3,
"Camera_fx": Float camera_focallenght_x,
"Camera_fy": Float camera_focallenght_y,
"Camera_px": Float camera_principlepoint_x,
"Camera_py": Float camera_principlepoint_y,
"timestamp": Double image_timestamps,
"image": String <image_byte_date_base64_Jpeg/png>
"version": string SDK_version
}