Postman Collection

postman is a tool to help test and build apis we've developed a postman collection that contains the complete set of api calls to make it all convenient for developers integrating with the platform apis what you need before getting started before you start with the postman collection, please make sure you have a developer account created on os1 developer portal , have registered an app , and have a set of getting started with building apps docid\ pimc8bwv2 c2qtgzc rvv (client id and client secret) with that, create an account on postman platform if you haven’t already refer to the postman collections below to start testing we will always have the latest versions of our postman collections post here os1 postman collection v3 9 1 https //archbee doc uploads s3 amazonaws com/pyxrbttf6wzpvekyaklwu/m4e82z2 oybh3hkyp3edc os1 postman collection v391postman collection json os1 environment file environment file app and solution postman collection we will always have the latest version of our postman collection post here v2 3 2 https //archbee doc uploads s3 amazonaws com/pyxrbttf6wzpvekyaklwu/h6nkd4zl9chxg3fqqcsjm app solution api v232postman collection json environment file https //archbee doc uploads s3 amazonaws com/pyxrbttf6wzpvekyaklwu/ofc rsjcuodxa4x41fzma apps and solns apispostmanenvironment json troubleshooting if you run into any issues with the collection, see our postman troubleshooting guide 📘 note note the os1 postman collection includes app & solutions , platform , dispatchone apis get started with the postman collection step 1 downloading & importing os1 postman collection to postman account open postman application > go to collections > click on the import button > in the dialog box, go to raw text and copy paste the code from git > click on import step 2 import the environment file to postman account now, visit the postman account > go to environments > click on the import button > in the dialog box, click on raw text > paste the file that you copied above > click on continue next, add the values of the different variables to the environment file table before that, make sure the osi environment file is selected open postman account > environments > osi environment file > add variables to start with, you’ll need to add client id , secret , baseurl ( tenant url ), request id (a random identifier; for example, request123 ), and tenant id to the environment file 🔐 you will get the client id , secret , tenant url , and tenant id after registering an app on os1 platform developer portal for more information about registering an app, see getting started with apps and solutions note that the variable values used in the above screenshot are made up and will not work if used to make a request step 3 generate access token in the postman app, go to collections > coreos services > token > click on send to make your request > you'll receive the token in the body as shown below add this access token to the environment file 🚧 ️ access token expiry the access token has an expiry date if after running an api, it says the token is expired, you can simply generate a new one by following the same steps mentioned in postman collection /#step 3 generate access token step 4 exploring apis the next step is to choose an endpoint from the right hand side navigation of the collection and start to build your request here, we will try out the entity service api to create a new entity, visit entity service > entity type apis > entity type post > in the request body, enter the details of the entity you want to create, for example, the name & category of the entity > hit send > in response, a new entity will be created & you'll get the entity id 🎉 you are now ready to explore other endpoints 📘 api reference 'try it' feature use the how to use the api 'try it' feature docid\ g9fgete5w1m9deb5a0sef to explore all the apis directly using the documentation portal