Skip to Content

Set Up Postman to Call Service Ticket Intelligence APIs

test
0 %
Set Up Postman to Call Service Ticket Intelligence APIs
Details

Set Up Postman to Call Service Ticket Intelligence APIs

October 7, 2021
Created by
July 9, 2020
Import Postman environment and collection JSON sample code files to call the Service Ticket Intelligence APIs.

You will learn

  • What Postman environments and collections are and how to use them
  • How to adjust the Postman environment for your service instance
  • How to import Postman environments and collections
QR code

In the following tutorials, Postman is used to communicate and interact with your Service Ticket Intelligence service instance. Postman is an API client used to call APIs. For more information, see Postman.


Step 1: Download locally Postman environment

If you have downloaded locally the Postman environment and collection sample files from the Set up account for Service Ticket Intelligence booster, as detailed in Set Up Account for Service Ticket Intelligence and Download Postman Sample Files, you can set steps 1 and 2 to Done and proceed with Step 3.

Postman offers the option to add environments. Environments represent key-value pairs which can be reused in requests, so you don’t have to remember them. For more information, see Postman Environments.

In step 5, you are going to use this feature to store your service key details obtained in Set Up Account for Service Ticket Intelligence and Get Service Key and reuse them in your requests to your service instance.

Make a local copy of the Postman environment sample file for Service Ticket Intelligence available on GitHub:

  1. Open the environment sample file.

  2. Click Raw.

    Postman
  3. Right click and then click Save as to download locally the JSON file.

    Postman
Where do you enter your service key details?
×
Step 2: Download locally Postman collection

Collections let you group requests together and save them for later use. This helps with the organization of requests as well as sharing requests. For more information, see Postman Collections.

Make a local copy of the Postman collection sample file for Service Ticket Intelligence available on GitHub:

  1. Open the collection sample file.

  2. Click Raw.

    Postman
  3. Right click and then click Save as to download locally the JSON file.

    Postman
Log on to answer question
Step 3: Import Postman collection and environment
  1. Open Postman and click Import to open the import dialog.

    Postman
  2. Drag and drop the Postman collection and environment JSON files in the import dialog. Click Import.

    Postman

A message appears to inform you about the successful import.

Postman

After you have imported the collection, it will appear on the left. As previously explained, the folder STI sample collection 2012 contains requests which you can use to call the Service Ticket Intelligence APIs.

Postman

You have successfully imported the Postman environment and collection for Service Ticket Intelligence.

Log on to answer question
Step 4: Select Postman environment

Env for STI sample collection 2012 now shows up in the environment dropdown menu.

Postman

Select it to be able to use the requests in the collection.

Postman
Log on to answer question
Step 5: Edit Postman environment

If you are using the Postman environment and collection sample files from the Set up account for Service Ticket Intelligence booster, as detailed in Set Up Account for Service Ticket Intelligence and Download Postman Sample Files, your service key details have already been entered in the Postman environment sample file. You can set this step to Done and proceed with the next tutorial: Use Service Ticket Intelligence and Postman to Classify Service Requests.

  1. Click Environment quick look.

    Postman
  2. Click Edit.

    Postman

    As detailed in the images below, enter the following values from your service key (obtained in Set Up Account for Service Ticket Intelligence and Get Service Key) into the corresponding spaces of the Manage Environments dialog box:

    Service key value Postman variable
    url (inside the uaa section of the service key) uaa_url
    sti_service_url (outside the uaa section of the service key) sti_service_url
    clientid (inside the uaa section of the service key) client_id
    clientsecret (inside the uaa section of the service key) client_secret
    PostmanPostman
  3. Click Update.

    Postman
  4. Click X.

    Postman

Now the Postman environment and collection are ready to be used in the next tutorial: Use Service Ticket Intelligence and Postman to Classify Service Requests.

Log on to answer question

Next Steps

Back to top