Open API
YSystem Open API uses HTTP POST endpoints. Public endpoint paths start with /v1/ or /v2/. Use the API address for your environment and the merchant keyword assigned to your channel.
API addresses
| Environment | API base URL |
|---|---|
| Development | https://dev-yapi.ytripos.com/ |
| Production | https://yapi.ytripos.com/ |
Append the version and endpoint path to the base URL. For example, the v2 hotel search endpoint in development is https://dev-yapi.ytripos.com/v2/hotel/search.
Getting started
- Request a channel and API credentials from the platform.
- Generate the request headers described in Authentication and signing.
- Choose v1 or v2 and build the JSON request body from the corresponding field reference.
- Handle pagination, asynchronous jobs, and business errors separately. Do not rely only on the HTTP status to determine whether a booking succeeded.
API versions
| Version | Typical use | Field reference |
|---|---|---|
| v1 | Existing hotel, order, job, and Webhook integrations | v1 Chinese · v1 English |
| v2 | New hotel, order, cruise, dictionary, and Webhook integrations | v2 |
The v1 and v2 signing rules are the same, but models and paths may differ. Use the module documentation for the version you selected.
Endpoint groups
- Hotels:
hotel/search,hotel/rates,hotel/rateRule,hotel/book - Orders:
order/search,order/analytics,order/cancel; see Order BI API for aggregation - v2 order amount fields and example: see Order search and amounts
- Jobs:
job/status - Cruise (v2):
cruise/itinerary/*,cruise/fares,cruise/price,cruise/cabin/*,cruise/meta/*,cruise/book - Webhook: see the
webhookmodule for the selected version
See the version references above for the complete endpoint list and model fields.
For /v2/order/search, a regular search returns at most 20 orders per page. When body.filter._ids is provided, the page limit is 100. Requests above the applicable limit are capped by the server.