Integration Requirements
Technical standards, security protocols, and compliance requirements that apply across all SMX API operations.
This page defines the technical standards, security protocols, and operational requirements that apply across all SMX API operations. These requirements ensure reliable, secure, and efficient connectivity between your application and the SiteMinder platform.
Compliance Policy
All integration partners must adhere to these requirements. Due to the growing number of partner integrations, SiteMinder can no longer accommodate exceptions.
Non-Compliance Timeline:
Partners have 90 days to remediate non-compliance issues after notification.
Failure to comply may result in interface deactivation.
Critical issues affecting production stability may result in immediate temporary suspension.
Technical Foundation
SMX uses two protocols depending on the operation:
Reservations — SOAP/XML over HTTPS (
OTA_HotelResNotifRQ)Availability and Rates — REST/JSON over HTTPS
Both protocols share the same transport and TLS requirements. Authentication differs per protocol — see Security below.
SOAP Protocol Requirements
SMX Reservations exclusively support SOAP 1.1.
Message Structure Standards:
All messages follow SOAP envelope structure
OTA message must be within
<SOAP-ENV:Body>Requests include SOAP Security Header (see Security)
Responses must use empty SOAP Header:
<SOAP-ENV:Header/>Content-Type:
application/xml; charset=utf-8(no other Content-Types accepted)Character Encoding: UTF-8 exclusively
SOAP 1.2 or other protocols are not supported for reservation messages. Systems using alternative protocols must be modified to use SOAP 1.1.
REST Protocol Requirements
SMX Availability, Restrictions, and Rates use REST/JSON.
Message Structure Standards:
All requests and responses are encoded as UTF-8
Content-Type:
application/jsonResponses include an
X-SM-REFERENCE-IDheader for request tracingWrite operations (POST, PUT) return
202 Acceptedwith amessageIdfor async status tracking
Security
Transport Layer Security
Minimum Standard: TLS 1.2 or higher
Requirements:
All communication must use HTTPS over port 443
HTTP (non-secure) connections are prohibited
Production endpoints must use valid SSL certificates
Self-signed certificates are not supported
Authentication
SMX uses different authentication methods per protocol:
Reservations (SOAP)
Authentication uses WS-Security (WSSE) UsernameToken within the SOAP Security Header. Credentials are transmitted as plain text within the HTTPS encrypted channel.
One set of credentials covers all properties in your integration
Your endpoint must validate credentials on every incoming request
Invalid credentials must return a SOAP fault with appropriate error code
Availability, Restrictions, and Rates (REST)
Authentication uses JWT Bearer Token passed in the Authorization header.
Token obtained via the SMX Subscriber Admin portal
Include on every REST request
For further details on JWT, see jwt.io.
Strong Password Policy (Reservations)
Minimum Requirements:
At least 12 characters long
Mix of uppercase and lowercase letters
At least one number
At least one special character (e.g.,
!@#?])
Example Strong Password: MyP@ssw0rd2024!Secure
Restricted Characters: Do NOT use the characters < > & " ' in usernames or passwords as they cause XML parsing issues.
IP Whitelisting (Optional)
Partners may whitelist SiteMinder IPs for additional security.
Pre-Production IPs:
52.13.134.14034.213.128.11335.164.250.223
Production IPs: Provided by the Partner Integrations team during go-live.
All SiteMinder requests originate from port 443 (HTTPS).
Configuration
Endpoint Requirements
Your Endpoint Requirements (Partner Provides):
A single global HTTPS endpoint to receive
OTA_HotelResNotifRQreservation messages from SiteMinderMust use a registered domain name — direct IP addresses are not supported
Must be accessible via HTTPS on port 443
Must accept SOAP 1.1 messages with Content-Type
application/xml; charset=utf-8One set of credentials covers all properties — authentication is application-level, not property-level
SiteMinder Endpoints (SiteMinder Provides):
REST base URL and credentials are provided by the Partner Integrations team during onboarding. DNS TTL must be respected — do not cache IP addresses indefinitely as this will cause connection timeouts.
Still have questions?
Use the Ask button at the top of the page to chat with our AI assistant — it can help you navigate the guide, understand requirements, and troubleshoot issues.
If you need more support, visit Integration Support.
Last updated
Was this helpful?