Process for setting up the Postman software and importing collections for API endpoints.
Postman software download:
Account set up:
- Set up a KYC360 work account (in the public space).
-
Open collections and then select the plus (+) symbol to create.
-
Select Blank Collection.
- This should open up a new section in the tree called New Collection.
- Hover over where it displays this and rename accordingly.
- Click over onto the Variables tab.
- Under the Variable section place both the designated names for;
- The URL name
- The API Key name
- Then under the Initial Value section put the actual values for both of the aforementioned above.
- The URL value
- The API Key value
- Then replicate these in the Current Value section as well.
Importing a Collection:
- Now go over and select the Import button
- The API flow documents for both products can be located and downloaded via the following URLs from our knowledge base:
- Within these documents, Page 4 will have information about how to set up the API Variables.
- And then from Page 5 onwards is the section for the JSON import details, which can be saved to a file.
- Click on Files, navigate to where you have saved the JSON file collection project files on your system and import them 1 by 1 (repeating the steps):
- Once you have completed the Import you should then see a separate tab open containing the collection of calls.
- You will then be able to click on any of these calls to open them individually and run them against the collection credentials which you have previously set up.
APIX Documentation (API Endpoints):
- For the specifics of the values required for these calls, you will need to reference this on the APIX (Prod and Test) pages, URLs below:
- Please Note: If there are any updates to the page containing these API endpoints, then that will need to be taken into consideration and revised/checked if any amends have been made