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. The API specification can be downloaded from the Usage Engine API page for 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 openapi.json specification in postman Postman as a Postman collectionCollection.


    Before accessing any API, you must create a bearer token must be created. This can be done using a Create access token You can do this by using the Create Access Token API endpoint POST /oauth/token which is found in the API in the authentication section fo the API specification.

  5. Add a Base URL(endpoint for your environment), the Base URL into the POST {{baseUrl}}/authentication/v1/oauth/token request and add the Client Id and Client Secret as a variable in your postman configurationin the body of the request. We recommend using a Postman variable for client Id, Client secret and token value.

  6. Send a request to generate token.

    Screenshot 2024-05-28 at 12.36.47.png

  7. Save the generated token as a variable.

  8. Go to the API that you want to send request. In this case, we show Usage metering List Meter Type API, in the example below, the Usage Metering API for List meter types.

  9. Go to Authorization tab, select Bearer token and variable Token in the Auth Type drop-down list and enter the variable you used to save your bearer token.

    Screenshot 2024-05-28 at 12.56.32.png

  10. Update the body and query parameters as desired with relevant parameters and send a the 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.

...