CTMS API - Testing Instructions: Difference between revisions
(Initial creation) |
(Updated to add SOAP webservices testing) |
||
| Line 2: | Line 2: | ||
* PostMan - download latest version from Google | * PostMan - 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/customer/create/ | ||
** https://server_or_ip_or_URL/orawsv/MTS_OWNER/DP_CTMS_IMPORT/IMPORT_ORDER | |||
* Request body XML - the TripOrder or OBS XML payload for the API method - consult examples or your documentation. | * 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. | |||
| Line 15: | Line 20: | ||
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== | ===Create Authorization=== | ||
Click Authorization tab | Click Authorization tab | ||
| Line 31: | Line 37: | ||
==Create Request== | ===Create Request=== | ||
Open collection you created and click Add Request | Open collection you created and click Add Request | ||
| Line 58: | Line 64: | ||
* Pretty/Raw for XML | * Pretty/Raw for XML | ||
* Preview if HTML | * Preview if HTML | ||
==SOAP Webservies== | |||
===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 | |||
[[Category: CTMS]] | [[Category: CTMS]] | ||
Revision as of 11:22, 19 March 2025
Requirements
- PostMan - 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.
Create a Collection
Create a new collection - name appropriately e.g. "CTMS Client System API".
RESTful webserviecs
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 Webservies
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
