Skip to content

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

  1. In the Collections pane, click the Import button
  2. Paste in the following url: https://app.optimeering.com/api/docs/openapi.json
  3. Click Import
  4. Click on the collection Optimeering, and then select the Variables tab in the main window
  5. Set the Current Value of the baseUrl to https://app.optimeering.com
  6. Select the Authorization tab
  7. Under Auth Type select OAuth 2.0
  8. Click the Edit Token Configuration button
  9. 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
  10. Scroll to the bottom, and click Get New Access Token

  11. Follow the prompts in your browser, make sure to allow Pop Ups
  12. Agree to Open Postman
  13. On successful request, click Proceed and then Use Token
  14. 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:

  1. Expand the Optimeering/api/predictions collections
  2. Click on List Series
  3. On the Params tab, deselect all the Query Params
  4. Click the Send button

Video Walkthrough

Powered by the Engineering Team