To execute a S7 Agent API operations, applications must send an HTTPS POST request to the S7 Agent API endpoint.
S7 Agent API doesn't support compressed request and/or response in GZIP format |
Table of contents:
Schemas
S7 Agent API makes WSDLs for most of major versions available for download.
When you are developing S7 Agent API applications that send requests and receive responses, you might find it helpful to validate the contents of your messages against the relevant schema.
The schemas are provided only for versions of APIs where it was changed. For example, if the 0.21 version of API includes WSDL link and the 0.26 isn't, then the schema of 0.21 conform for both those API versions.
Headers
The following table describes the HTTP headers that you typically set in a S7 Agent API request:
| # | Name | Mandatory | Key in headers | Description |
|---|---|---|---|---|
| 1 | Version of API | Optional | X-API-Version | Depends on version of API that you want to execute
|
| 2 | Basic authorization string | Required | Authorization | Credentials that you received from our S7 technical support. Check out Quick Start for how to get it |
| 3 | Operation name | Required | SOAPAction | Depends on operation that you want to execute |
| 4 | Type of content | Required | Content-Type | Sets the content type of the request. Always "text/xml" |
If you didn't pass Version of API in request a default one will be executedS7 agent API required encrypted HTTP requests via HTTPS only. Check out Quick Start for how to get SSL certificate.
The following example shows headers of a typical SearchFlights operation of 0.35 version API on Test environment:
POST /agent-api/gaia HTTP/1.1 Host: qa-gaia.s7.ru Content-Type: text/xml SOAPAction: "http://api.s7.ru/SearchFlights" X-API-Version: 0.35 Authorization: Basic oV5zbWlyCx92X3M3dfS6dGFpbDpxLTE2OXFs |
Versions
You can use any released versions if your requests conform that syntax. Check references for detailed explanation of input&output parameters and possible errors for every version of API.
If you didn't pass Version of API in request a default one will be executed. You always able to check executed API version in response headers.
But we recommend that you always specify version in all you request to avoid unexpected responses form another versions of API.
Operation names
Applications must send the "SOAPAction" key in headers of request to the S7 Agent API for determination of operation.
| # | 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" |