Obtain your Credentials

overview in this guide, you'll learn how to register your first application with os1 you have the flexibility to register your app either using the api or through the developer portal additionally, you'll learn how to retrieve and use your platform credentials for more details, refer to the apps and solutions c oncept chapter step 1 register your app registering an app with os1 can be done easily using either the api or the developer portal follow these steps to get your app registered and ready for integration on the platform using the api developers can register their applications via api by calling the registerapp endpoint follow the steps below to register an web app prepare the application details json based on the registerapp parameters set the required parameters like displayname , type , listingid , version , isconsolecompatible , shortdescription , categories , and menu make a post request to the endpoint registerapp with the application details json the api will validate the details and register the app on success, the api returns a 201 status code with the registered application details the application will now be available in the developer portal example request register 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" } using the developer portal after setting up your team, it’s time to register your app follow the steps below sign in to the os1 developer portal from the left navigation pane, select apps click create your first app fill in the following required information for your app app listing name the name of your app app type web, mobile, or backend description a short description of the app version the version of your app using semantic versioning formatting web apps if you’re creating a web app, complete the following information 5\ the relative path of the app landing page this path will be used to form the final url while rendering the app from the console for example https //tenantaname myorg com/application/myorgapp/ https //tenantaname myorg com/application/myorgapp/ select console compatible to make the app compatible with the console app launch experience click register app to submit the registration accessing web apps from the console accessing web apps from the console after you register a web app, you’ll be able to access them in the console ui using the tenant id and your console url https //tenantname sandbox getos1 com the registration process may take a few minutes to complete once your app is successfully registered, you will be redirected to the apps overview page this page contains your app's credentials, which include your client id , client secret , tenant url , and tenant id step 1 obtain credentials to authenticate your apps on the platform, you need to obtain your credentials you can access your credentials either through the api or the os1 developer portal however, keep in mind that your app must pass the tech review and have at least one approved version to get your credentials retrieve credentials via the api prerequisites application registered on os1 platform with id {appid} get the appid value for your application you can find this in the registerapp response call getprodcredentials with your appid the json response contains your application's production credentials use the clientid and clientsecret to authenticate your production application requests to os1 apis { "clientid" "{client id}", "clientsecret" "{client secret}" } view credentials in developer portal select apps in the left navigation bar to view a list of your registered apps click the icon under credentials to view the following credentials for your app app id the unique id for your app client id and client secret generates an access token for authentication tenant id and tenant url specify the path to the sandbox environment you’re using to copy your credentials, click the copy icon next to the credential service and frontend if you register one web app type you will receive credentials for backend and frontend service (backend) use the client id and client secret in your backend to generate access tokens and make api calls on the platform frontend (mobile/web) use the front end credentials within your front end with authentication and authorization(aaa) sdk to generate an otp that gives your users access to the platform resources through your ui