CTMS API - Testing Instructions - Revision history

Anw: Updated

2025-03-19T10:17:18Z

Updated

← Older revision		Revision as of 12:17, 19 March 2025
Line 1:		Line 1:
			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==		==Requirements==
	* Testing App, one of:		* Testing App, one of:

Anw: Minor correction

2025-03-19T09:28:49Z

Minor correction

← Older revision		Revision as of 11:28, 19 March 2025
Line 23:		Line 23:


	===RESTful ~~webserviecs~~ ===		===RESTful webservices ===

	====Create Authorization====		====Create Authorization====

Anw: Added SoapUI information

2025-03-19T09:27:22Z

Added SoapUI information

← Older revision		Revision as of 11:27, 19 March 2025
Line 1:		Line 1:
	==Requirements==		==Requirements==
			* Testing App, one of:
	* PostMan - download latest version from Google		** PostMan - download latest version from Google
			** SoapUI - download latest version from Google
	* Request URL - the URL to the CTMS ORDS webservice e.g.		* Request URL - the URL to the CTMS ORDS webservice e.g.
	** https://server_or_ip:8510/ords/import/order/create/		** https://server_or_ip:8510/ords/import/order/create/
Line 16:		Line 17:


	==Create a Collection==		==PostMan==
			===Create a Collection===

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

	~~==RESTful webserviecs ==~~

	===Create Authorization===		===RESTful webserviecs ===

			====Create Authorization====

	Click Authorization tab		Click Authorization tab
Line 37:		Line 40:


	===Create Request===		====Create Request====

	Open collection you created and click Add Request		Open collection you created and click Add Request
Line 66:		Line 69:


	==SOAP ~~Webservies~~==		===SOAP Webservices===

	===Create Request===		====Create Request====

	Open collection you created and click Add Request		Open collection you created and click Add Request
Line 98:		Line 101:
	* Preview if HTML		* 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.


	[[Category: CTMS]]		[[Category: CTMS]]

Anw: Anw moved page CTMS API - PostMan Instructions to CTMS API - Testing Instructions

2025-03-19T09:22:49Z

Anw moved page CTMS API - PostMan Instructions to CTMS API - Testing Instructions

← Older revision	Revision as of 11:22, 19 March 2025
(No difference)

Anw: Updated to add SOAP webservices testing

2025-03-19T09:22:00Z

Updated to add SOAP webservices testing

@@ Line 2: / Line 2: @@
 * PostMan - download latest version from Google
 * Request URL - the URL to the CTMS ORDS webservice e.g.
-** http://server_or_ip:8510/ords/import/order/create/
+** https://server_or_ip:8510/ords/import/order/create/
-** http://server_or_ip:8510/ords/import/customer/create/
+** https://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.
@@ Line 15: / Line 20: @@
 Create a new collection - name appropriately e.g. "CTMS Client System API".
-==Create Authorization==
+===Create Authorization===
 Click Authorization tab
@@ Line 31: / Line 37: @@
-==Create Request==
+===Create Request===
 Open collection you created and click Add Request
@@ Line 58: / Line 64: @@
 * Pretty/Raw for XML
 * Preview if HTML
 [[Category: CTMS]]

Anw: Initial creation

2025-02-21T11:40:31Z

Initial creation

New page

==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

[[Category: CTMS]]