Versions Compared

Old Version 8

changes.mady.by.user Pavel A. Smirnov (Deactivated)

Saved on

compared with

New Version 9

changes.mady.by.user Pavel A. Smirnov (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To execute a S7 Agent API operations, applications must send an HTTPS POST request to the S7 Agent API endpoint.

For validating your requests that they conform to API's schemas use WSDLs.


Note

S7 Agent API doesn't support compressed request and/or response in GZIP format


Table of contents:

Table of Contents

Environments

Excerpt




TestProduction
#VersionEndpointEndpoint
10.21WSDLDefaultWSDLDefault
20.35WSDL
Not installed


Note

If you are ready to a new versions which are not installed on production environment — notify our technical support by JIRA



Note

Follow steps to quickly get an access to API

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:

#NameMandatoryKey in headersDescription
1Version of APIOptionalX-API-Version

Depends on version of API that you want to execute

(warning) If you didn't pass Version of API in request a default one will be executed

2Basic authorization stringRequiredAuthorizationCredentials that you received from our S7 technical support. Check out Quick Start for how to get it
3Operation nameRequiredSOAPActionDepends on operation that you want to execute
4Type of contentRequiredContent-TypeSets the content type of the request. Always "text/xml"

S7 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:

Code Block
linenumberstrue
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.

#OperationSOAPAction value (actual for v0.35)
1agentPayment"http://api.s7.ru/AgentPayment"
2baggageCharges"http://api.s7.ru/BaggageCharges"
3book"http://api.s7.ru/Book"
4cancelBooking"http://api.s7.ru/CancelBooking"
5changeBook"http://api.s7.ru/ChangeBook"
6demandTickets"http://api.s7.ru/DemandTickets"
7findRules"http://api.s7.ru/FindRules"
8read"http://api.s7.ru/Read"
9reprice"http://api.s7.ru/Reprice"
10retrieveTicket"http://api.s7.ru/RetrieveTicket"
11searchFlights"http://api.s7.ru/SearchFlights"
12seatMap"http://api.s7.ru/SeatMap"
13servicePrice"http://api.s7.ru/ServicePrice"
14voidTicket"http://api.s7.ru/VoidTicket"

Common questions

Excerpt Include
Common | FAQ
Common | FAQ
nopaneltrue