Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Create an Application Access in Usage Engine as described in Configuring Application Access. Ensure to copy the Client Secret since it will only be visible when creating the Application Access.

  2. Either download the Postman app, or select to run it in a browser, and create an account and sign in.

  3. Go to the workspace and import the OPEN API specification. The API specification can be downloaded from the endpoint of your environment Environments. Import the downloaded The detailed documentation of the API is available on the same endpoint.

  4. Go to the workspace and import the OPEN API specification in the postman as Postman collection.

  5. Click on the REST API basics tutorial, and your workspace opens with a basic set of requests; GET, POST, PUT, DEL.

    Postman1.pngImage Removed
  6. Select one of the methods and click on the Authorization tab to configure the application authentication.

    Authorization.pngImage Removed
  7. Click on the Type drop-down and select OAuth 2.0.

  8. Scroll down to the Configure New Token section.

    New-token.pngImage Removed
  9. Paste the Client ID and Client Secret details from the Configuring Application Access Application Access you created in Usage Engine in the first step.

Note!

You will see a warning advising you to use variables instead of entering the credentials in clear text. If you want to use variables, you can set this up by clicking on the Environments option in the navigation panel to the left in Postman.

...

Select Client Credentials in the Grant type drop-down.

...

Enter https://auth.digitalroute.io/auth/token in the Access Token URL field.

...

Define the audience of the token by scrolling down to the Token Request section select audience as Key in the table, enter the URL to the Usage Engine APIs, https://api.us.digitalroute.io/ in the Value field and leave the default setting Request Body in the Send In field as is.

...

Save your Authorization configuration to a collection by clicking on the Save button top right and either select an existing Collection, or create a new one.

...

Click on the Get New Access Token button.

...

If everything went well you will get a message saying “Authentication complete” and the Manage Access Tokens dialog will open displaying your token details.

...

  1. Before accessing any API, bearer token must be created. This can be done using a Create access token API in the authentication section.

  2. Add a Base URL(endpoint for your environment), Client Id and Client Secret as a variable in your postman configuration. We recommend using a Postman variable for client Id, Client secret and token value.

  3. Send a request to generate token.

    Screenshot 2024-05-28 at 12.36.47.pngImage Added

  4. Save the generated token as a variable.

  5. Go to the API that you want to send request. In this case, we show Usage metering List Meter Type API.

  6. Go to Authorization tab, select Bearer token and variable used to save bearer token.

    Screenshot 2024-05-28 at 12.56.32.pngImage Added

  7. Update the body and query parameters as desired and send a request.

    Screenshot 2024-05-28 at 12.57.02.pngImage Added

You can now create, list, update or delete the API endpoints provided by Usage Engine.

For more information on postman variables and environments, refer to Postman variable and environment. You can save the configuration of various environment like sandbox and production using environments.