CTMS API - Testing Instructions

Requirements

• PostMan - download latest version from Google
• Access Token URL e.g. http://server_or_ip:8510/ords/import/oauth/token
• Client ID - usually 24 random characters
• Client Secret - usually 24 random characters
• Request URL - the URL to the CTMS ORDS webservice e.g.
  • http://server_or_ip:8510/ords/import/order/create/
  • http://server_or_ip:8510/ords/import/customer/create/
• Request body XML - the TripOrder or OBS XML payload for the API method - consult examples or your documentation.

Create a Collection

Create a new collection - name appropriately e.g. "CTMS Client System API".

Create Authorization

Click Authorization tab

Set Type to OAuth2

Configure new token - enter the following as provided

• Access Token URL
• Client ID
• Client Secret
• Give the token a name, so it can be found easier later.

Save, then request a new token - should create a token in the Current Token Section

Create Request

Open collection you created and click Add Request

Click the name in the header and change to a reasonable name, e.g. if creating customer onboarding, call it Customer, if order import, call it Order, etc.

Change request type to POST from dropdown list.

Enter URL, as provided

Click Authorization

• Change type to OAuth2
• Click Token on the right and select your token name created above.

Click Body

Click Raw

Enter XML required.

Click Save

Click Send

Result will be shown in the bottom panel.

• Pretty/Raw for XML
• Preview if HTML