App and Solution
Apps
Registering Your App
5 min
overview the registerapp api allows developers to register apps with the os1 platform this api supports three app types, including web, mobile, or backend endpoint post /developer/apps query parameters parameter description organizationid the unique id of the organization teamid the unique id of the team register app attributes true false 219false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type false left unhandled content type required attributes required attributes ( ) indicates that the attribute is required example request the following request registers an app for tracking vehicles web app { 	"displayname" "truck tracker", 	"type" "web", 	"listingid" "truck trackers", 	"version" "1 0 2", 	"isconsolecompatible" true, 	"isprivate" true, 	"url" { 	 "relativepath" "truck trackers", 	 "stackid" " ", 	 "server" "your kubernetes cluster svc cluster local", 	 "interface" "/", 	 "admin" "admin", 	 "setting" "settings", 	 "userguide" "docs", 	 "gitinfo" "https //github com/your org/your repo" 	}, 	"shortdescription" "a truck tracker that allows you to track your trucks ", 	"longdescription" "dig deep into the details of your truck maintenance schedules as well as locations receive notifications when a vehicle hits a maintenance milestone ", 	"categories" \[ 	 "vehicle", 	 "tracking" 	], 	"menu" \[{ 	 "displayname" "inventory", 	 "displayorder" 4, 	 "relativepath" "inventory" 	}], "packagename" "com example vehicletracker" } mobile app { 	"displayname" "vans tracker", 	"type" "mobile", 	"listingid" "mbbile vans trackers", 	"version" "1 0 2", 	"isconsolecompatible" false, 	"isprivate" true, 	"url" { 	 "relativepath" "/vantrackers", 	 "stackid" " ", 	 "server" "your kubernetes cluster svc cluster local", 	 "interface" "/", 	 "admin" "admin", 	 "setting" "settings", 	 "userguide" "docs", 	 "gitinfo" "https //github com/your org/your repo" 	}, 	"shortdescription" "a truck tracker that allows you to track your trucks ", 	"longdescription" "dig deep into the details of your truck maintenance schedules as well as locations receive notifications when a vehicle hits a maintenance milestone ", 	"categories" \[ 	 "vehicle", 	 "tracking" 	], 	"menu" \[{ 	 "displayname" "inventory", 	 "displayorder" 4, 	 "relativepath" "inventory" 	}], "packagename" "com example vantracker" } example response web { "data" { "id" { "appid" "app 6f2cef3c 2df1 5d67 ad92 f89ca7f4a226", "appversionid" "appversion 6e6f5c0f 8a92 550c bb4f 5102e2e7e2fc" } }, "request" { "url" "/developer/apps?organizationid=af86b55e 45c9 41ee 95f7 d335d366022f\&teamid=87dd5441 e8c4 4171 ba24 79f47992ba9b", "method" "post", "params" {}, "query" { "organizationid" "af86b55e 45c9 41ee 95f7 d335d366022f", "teamid" "87dd5441 e8c4 4171 ba24 79f47992ba9b" }, "body" { "displayname" "van tracker", "type" "web", "listingid" "web van trackers", "version" "1 0 2", "isconsolecompatible" true, "url" { "relativepath" "/vantrackers", "stackid" " ", "server" "your kubernetes cluster svc cluster local", "interface" "/", "admin" "admin", "setting" "settings", "userguide" "docs", "gitinfo" "https //github com/your org/your repo" }, "shortdescription" "a truck tracker that allows you to track your trucks ", "longdescription" "dig deep into the details of your truck maintenance schedules as well as locations receive notifications when a vehicle hits a maintenance milestone ", "categories" \[ "vehicle", "tracking" ], "menu" \[ { "displayname" "inventory", "displayorder" 4, "relativepath" "inventory" } ], "packagename" "com example vantracker" } } } mobile { "data" { "id" { "appid" "app\ c2a99e35 afc2 5407 8efb c5f189600f13", "appversionid" "appversion 04348faf f185 52a3 a68a 8002f7307bd5" } }, "request" { "url" "/developer/apps?organizationid=af86b55e 45c9 41ee 95f7 d335d366022f\&teamid=87dd5441 e8c4 4171 ba24 79f47992ba9b", "method" "post", "params" {}, "query" { "organizationid" "af86b55e 45c9 41ee 95f7 d335d366022f", "teamid" "87dd5441 e8c4 4171 ba24 79f47992ba9b" }, "body" { "displayname" "vans tracker", "type" "mobile", "listingid" "mbbile vans trackers", "version" "1 0 2", "isconsolecompatible" false, "url" { "relativepath" "/vantrackers", "stackid" " ", "server" "your kubernetes cluster svc cluster local", "interface" "/", "admin" "admin", "setting" "settings", "userguide" "docs", "gitinfo" "https //github com/your org/your repo" }, "shortdescription" "a truck tracker that allows you to track your trucks ", "longdescription" "dig deep into the details of your truck maintenance schedules as well as locations receive notifications when a vehicle hits a maintenance milestone ", "categories" \[ "vehicle", "tracking" ], "menu" \[ { "displayname" "inventory", "displayorder" 4, "relativepath" "inventory" } ] } } } ❗ unauthorized error unauthorized error an unauthorized error occurs when using an incorrect orgid or teamid confirm you are using the correct orgid or teamid