Postman
You can easily setup Postman to make API Requests to app.optimeering.com
.
Prerequisites
For the following we recommend using the Postman App. You can download it from https://www.postman.com/downloads/
Importing and Configuring the Collection
- In the Collections pane, click the
Import
button - Paste in the following url:
https://app.optimeering.com/api/docs/openapi.json
- Click
Import
- Click on the collection
Optimeering
, and then select theVariables
tab in the main window - Set the
Current Value
of thebaseUrl
tohttps://app.optimeering.com
- Select the
Authorization
tab - Under
Auth Type
selectOAuth 2.0
- Click the
Edit Token Configuration
button -
Update the fields with the following values:
Key Value Token Name OptimeeringToken GrantType Implicit Authorize using browser Enabled Auth URL https://login.microsoftonline.com/d23844a4-14b7-4e42-9e3a-be7fcb83625b/oauth2/v2.0/authorize Client ID 1cf03eed-1870-46c7-a192-e91b7aa4912d Scope api://app.optimeering.com/user_impersonation -
Scroll to the bottom, and click
Get New Access Token
- Follow the prompts in your browser, make sure to allow Pop Ups
- Agree to Open Postman
- On successful request, click
Proceed
and thenUse Token
- Click on
Save
Sending a Request
The settings from above are inherited by each route on the collection, so it's easy to initiate a request. For example, to list all the predictions series:
- Expand the
Optimeering/api/predictions
collections - Click on
List Series
- On the
Params
tab, deselect all the Query Params - Click the
Send
button