Versions Compared

Key

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

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"
Note

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 any released versions if your requests conform that syntax.

If you didn't pass Version of API in request it will be execute the default one. But we recommend that you always specify version in all you request to avoid unexpected responses form another versions of API.

Operation names

Response

Identifying requested version of API


Successful results


Unsuccessful results

Common questions

Excerpt Include
Common | FAQ
Common | FAQ
nopaneltrue

Table of contents:

Table of Contents

Environment

Excerpt




TestProduction
#VersionEndpointEndpoint
10.21WSDL(tick)WSDL(tick)
20.35WSDL
(error)

(tick) — default version for environment

(error) — not installed on environment

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