The Simple Hospitality Interchange Protocol, or SHIP, is a JSON-based message format, combined with a simple HTTP-based API, that aims to make it easy for hospitality-related systems and applications to exchange messages. This SDK contains the specifications for the JSON messages in both human- and machine-readable forms, plus a number of sample messages. For details on the HTTP-based API, please contact your SHIP integration partner.
This SDK can be downloaded from the releases page. There is one release for each version of the SHIP message specifications.
SHIP defines a small number of JSON-based messages to be used for hospitality interchange. The JSON schemata for the available message types are located in the schemata directory. The schema files located in the schemata directory can be used to validate JSON documents for conformance to SHIP. For more details about JSON schema see http://json-schema.org/.
In addition to the JSON schemata, the SHIP messages are described in more human-friendly form in the docs directory. The documentation is broken down into the following sections:
A single-page version of the documentation can also be found at https://revinate.github.io/ship-sdk/.
Sample messages for each of the SHIP message types can be found in the samples directory. The sample messages therein are broken down by their message types.
-
ship-java - Java implementation of the SHIP message types.
-
ship-scala - Scala implementation of the SHIP message types.