Integration Requirements
Guidelines
As outlined in the API Services Terms of Use Agreement, these guidelines ensure the efficient and proper use of the pmsXchange API.
All PMS/RMS/CRS that integrate with SiteMinder must adhere to the following requirements. PMS/RMS/CRS with existing integrations may need to update their setup to comply. Due to the growing number of PMS/RMS/CRS installations, SiteMinder can no longer accommodate exceptions.
Failure to comply with these guidelines may result in the deactivation of the PMS interface. If non-compliance is not resolved within three months of notification, SiteMinder reserves the right to disable the interface until corrections are made. In cases where non-compliance poses a risk to SiteMinder's production environment, the interface may be disabled immediately.
Application General
SOAP Message
All SOAP messages communication between SiteMinder and the PMS/RMS/CRS must be transmitted over secure HTTP (HTTPS). These messages include a SOAP Security header for authentication and a SOAP Body containing the OTA message. The communication operates through synchronous request/response pairs, where each message is considered atomic—processed entirely or not at all by the Web Service.
Content-Type
All SOAP XML requests to SiteMinder must have a Content-Type of 'text/xml; charset=utf-8'. Other Content-Types will not be accepted.
File Upload Size
Uploaded messages must not be larger than 2MB (uncompressed). Messages received that are greater than this size will not be processed and a soap fault will be returned. Messages larger than 2MB will need to be broken down into smaller messages or the updates bundled more effectively.
SSL/TLS
pmsXchange API supports TLSv1.2
API General
EchoTokens
EchoTokens are crucial for all requests made over pmsXchange. Each EchoToken must be unique per request to ensure that every request can be individually identified for troubleshooting in both testing and production environments. This token will be returned in the response.
TimeStamp
The TimeStamp format must follow ISO 8601 Date and Time standards. There are two ways to handle time zone offsets:
UTC time is indicated by a "Z" at the end (e.g.,
2021-11-05T13:15:30Zfor UTC time).Local time includes a time zone offset (e.g.,
2021-11-05T08:15:30-05:00for US Eastern Standard Time, which is 5 hours behind UTC).
Line Spacing
All SOAP XML requests to SiteMinder must be minified, containing no line spacing or newline characters. Keeping the XML on a single line helps our support teams extract messages from logs more efficiently.
Last updated
Was this helpful?