Postman Collection

Developers can quickly explore Smart Bonding API examples and test live API requests using the collection available for use with the Postman REST Client.

This collection offers examples for common API requests:

  • POST Generating an OAuth Token
  • POST Creating a Shadow Ticket
  • POST Creating an Escalated Ticket
  • POST Updating a ticket with Work Notes
  • POST Adding an attachment
  • POST Escalating a Shadow Ticket to Cisco
  • POST Resolving a Ticket
  • POST Closing a Ticket
  • GET Pulling Ticket Updates from Cisco
  • GET Pulling TSP Codes from Cisco

Note: Smart Bonding API credentials (client_id/client_secret) are required to start making requests, see Authentication.

Importing the Postman Collection

  1. Download a copy of the collection (right-click, Save As) --> Postman Collection

  2. Import the collection .json file into Postman (see instructions):

    image

    After importing, all available methods will be shown:

    image

Generating an Access Token

Before making REST API requests, an access token must be retrieved:

  1. In Postman, open the Smart Bonding API collection "..." menu.

    Click Edit, then select the Variables tab:

    Collection Variables

  2. In the Current Value column, enter the following values:

    • server:

      • stage.sbnprd.xylem.cisco.com for the testing environment.
      • sb.xylem.cisco.com for production.

    • client_id

    • client_credentials

    Be sure to Save collection:

    Save Collection

  3. From the collection tree, select the Generate Token request, then click Send.

    The access token will be displayed and will also be automatically parsed/stored in a collection variable for re-use with other requests.

    Note: access tokens expire after 1 hour. Re-send the Generate Token request to get a new access token if needed.

Making Your First Request

Once an access token has successfully been retrieved, additional REST API requests can be sent without any further authorization config.

GET requests should work without modification, however for any of the POST requests you will want to modify the example JSON content in the Body to reflect valid request data:

Create Ticket