To execute a S7 Agent API operations, you submit an HTTPS request to the QPX S7 Agent API endpoint.
Request
Applications must send an HTTPS POST request.
All requests to S7 Agent API must include the following:
- Version of API (the "X-API-Version" key in headers) – check Environment table for a value below
- Basic authorization string (the "Authorization" key in headers) — credentials that you received from our technical support. Check out Quick Start for how to get it
- Operation name (the "SOAPAction" key in headers) — check Operation table for a value below
- Type of content (the "Content-Type" key in headers) — always "text/xml"
S7 Agent API doesn't support compressed request and/or response in GZIP format
S7 agent API required encrypted HTTP requests via HTTPS only. Check out Quick Start for how to get SSL certificate.
For validating your requests that they conform to API's schemas use WSDLs. Links provided in Environment table.
Version of API
You can use other versions if your requests conform that syntax.
If you didn't pass Version of API in request it will be execute the default. But we recommend that you always specify version in all you request to avoid unexpected responses form another versions of API.
Operation names
| # | Operation | SOAPAction value (actual for v0.35) |
|---|---|---|
| 1 | agentPayment | "http://api.s7.ru/AgentPayment" |
| 2 | baggageCharges | "http://api.s7.ru/BaggageCharges" |
| 3 | book | "http://api.s7.ru/Book" |
| 4 | cancelBooking | "http://api.s7.ru/CancelBooking" |
| 5 | changeBook | "http://api.s7.ru/ChangeBook" |
| 6 | demandTickets | "http://api.s7.ru/DemandTickets" |
| 7 | findRules | "http://api.s7.ru/FindRules" |
| 8 | read | "http://api.s7.ru/Read" |
| 9 | reprice | "http://api.s7.ru/Reprice" |
| 10 | retrieveTicket | "http://api.s7.ru/RetrieveTicket" |
| 11 | searchFlights | "http://api.s7.ru/SearchFlights" |
| 12 | seatMap | "http://api.s7.ru/SeatMap" |
| 13 | servicePrice | "http://api.s7.ru/ServicePrice" |
| 14 | voidTicket | "http://api.s7.ru/VoidTicket" |
Response
Identifying requested version of API
Successful results
Unsuccessful results
Common questions
Question | Answer | |||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 1 | How to access the product environment? | If you are newbie, just follow the steps, which provides the simplest way to quickly get an access to API Or you already adopted your systems to our test environment? Notify our technical support by Kaiten for final testing under the supervision of our technologists and proceed to signing of the contract of EDS | ||||||||||||||||||||
| 2 | How to access the test environment? | |||||||||||||||||||||
| 3 | Which endpoints should be used? | Explore the ways of submitting requests:
| ||||||||||||||||||||
| 4 | How does the standard ticketing scenario looks? | Simple operation flow: searchFlightsJourney (AirShoppingRQ) → book (OrderCreateRQ) → reprice (ItinReshopRQ) → demandTickets (AirDocIssueRQ) Discover more scenarios from simplest flows to best practices | ||||||||||||||||||||
| 5 | Is it possible to use social categories of passengers: pensioners, youth, sailors, students, etc.? What types of passengers are available in the API? | No, only 3 types of passengers are available:
| ||||||||||||||||||||
| 6 | How can I get information about flights commissions and manage agency fees? | For any financial questions you have to contact S7's sales department or your account manager via at vm@s7.ru | ||||||||||||||||||||
| 7 | Is the Multi-City method implemented in API? | Yes, check searchFlights operation overview to find out. Samples will be available soon! | ||||||||||||||||||||
| 8 | Is the refund method implemented in API? | No, the refunds are not implemented | ||||||||||||||||||||
| 9 | Can I get an S7 route map? | There is no such request in API | ||||||||||||||||||||
| 10 | Are all S7 fares branded? | Yes, all fares are split into 3 fare families, from the cheapest to the most equipped fare:
| ||||||||||||||||||||
| 11 | Can I get a terminal text view of the current PNR data? Or just build a template from an XML response? | No, only XML display is available for input and output | ||||||||||||||||||||
| 12 | Does the service support queues? | All requests to API are synchronous, queues are not used | ||||||||||||||||||||
| 13 | I recieve "Unknown operation" in response, while requests executed in SoapUI | Check using of correct HTTP header of your requests:
Also you can find out how to handle with unsuccessful result and common access errors | ||||||||||||||||||||
| 14 | When I try the link https://qa-gaia.s7.ru/agent-api/wsdl/0.52?wsdl I get an error: "400 Bad Request. No required SSL certificate was sent." | You didn't use a right SSL certificate to download API's WSDL. Check you used certificate for the test environment (not for production):
Also you can find out how to handle with unsuccessful result and common access errors | ||||||||||||||||||||
| 15 | I always recieve an error: "Can not perform operation without valid RequestorID" | Probably, you used incorrect Agent credentials in Party tag. Contact to S7 API support with used credentials Also you can find out how to handle with unsuccessful result and common access errors |
Table of contents:
Environment
If you are ready to a new versions which are not installed on production environment — notify our technical support by JIRA
— default version for environment
— not installed on environment