CTMS API - Testing Instructions
The intention of this document is to show the basic, generic instructions on testing CTMS webservices, either RESTful (through ORDS) or SOAP. This does not cover the implementation or setup of these webservices (which is currently undocumented and the purview of TechHub), nor the functionality of the webservices themselves (which is documented in the CTMS Assist).
Requirements
- Testing App, one of:
- PostMan - download latest version from Google
- SoapUI - download latest version from Google
- Request URL - the URL to the CTMS ORDS webservice e.g.
- Request body XML - the TripOrder or OBS XML payload for the API method - consult examples or your documentation.
- Restful Web Services ONLY
- 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
- SOAP Web Services ONLY
- Authorisation user
- Authorisation password.
PostMan
Create a Collection
Create a new collection - name appropriately e.g. "CTMS Client System API".
RESTful webservices
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
SOAP Webservices
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, without the wsdl if provided.
Click Authorization tab
Set Type to Basic
Enter user and password
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
SoapUI
SOAP Webservices
Click New SOAP
- Name appropriately.
- Enter the URL plus the wsdl
- Save - a request should be created for you.
Note: You can create a project with multiple requests or a single request, depending on the WSDL provided.
Find the request and double-click.
Paste the payload XML into the appropriate place in the message.
Click the Play button - the results are shown on the right-hand side - usually XML shows the best result.
