Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Postman is an API platform that you can use to access the APIs. It can be downloaded from https://www.postman.com/downloads/ and you can select to either run it in a downloadable app or in the browser.

To access your APIs using Postman:

  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. The API specification can be downloaded from the endpoint of your environment Environments. The detailed documentation of the API is available on the same endpoint.

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

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

  6. 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.

  7. Send a request to generate token.

    Screenshot 2024-05-28 at 12.36.47.png

  8. Save the generated token as a variable.

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

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

    Screenshot 2024-05-28 at 12.56.32.png

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

    Screenshot 2024-05-28 at 12.57.02.png

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.

  • No labels