SOAP Web Services Intro

Updated 1 month ago by Leigh Hutchens

Getting started

To get started with Quinyx Web Services, there are a few things you will need to know. Quinyx Web Services is a NuSOAP based collection of web service methods enabling external systems to import and export data to the Quinyx WFM database.

API Documentation

Full documentation can be found here.

Environments

Release Candidate

Release candidate (RC) is our customer environment (Release Candidate) where you as a customer can access your data in a sandbox environment. It will contain your customer data from the production environment up until last month. The data in this environment gets updated on the evening of the 1st of each month and will overwrite all changes made in the RC environment.

Production

This is the production environment which is reached through:

Important information about integrations

We encourage all our customers to make use of our APIs to maintain data and make sure that information is up to date. To ensure scalability of our APIs while growing our customer and user base, we have decided to add restrictions on usage of our SOAP APIs. These restrictions will be enforced programmatically and means that we will enforce a limit on concurrent calls per customer to 10. You should expect response code 429 if you happen to exceed this limit and you are recommended to implement a backoff-retry mechanism to handle the limit. We will start by introducing the limit at a higher level which will not affect any customers’ usage on RC for testing purposes within the next month and on Production January 14th. The limit of 10 concurrent calls will be introduced on RC January 21st and on Production February 10th.Note that the limit applies to SOAP only. When moving from SOAP to Rest over the following years, any limits will be built into the API. Please make sure to forward this information to the party within your company responsible for integrations.

Restrictions

  • Concurrent call per customer in Quinyx : 10

For testing and development purposes the Web Services can be accessed via the following URL:

For live application (production) purposes the Web Services can be accessed via the following URL (use only for live transactions):

Opening these links in a web browser allows inspection of the methods.

API key

Most, if not all, of the web service methods require you to provide an API key. The API key is a unique string used to identify which unit the call is made for. A unit is an organisational entity in Quinyx WFM such as a store or restaurant. Some methods allow fetching of data for the whole organisation, in which case you are required to provide the main unit’s API key. The main unit is the organisations root unit (first unit), most often set up as the headquarters or central office.

The unit’s API key can be found in the unit settings in Quinyx under Settings.

  1. Click on the Settings tab.
  2. Click the Units sub link (note that it may be called Stores or Restaurants etc, depending on the organisation’s industry).
  3. Click on the desired unit.
  4. Click on the SMS/Integration tab.
  5. Click Show.
Note : The access rights for this is default non visible for security reasons. So if the above is not applicable please check access rights settings for the affected users

IP address lockout (Whitelisting)

We recommend organisations to limit from which IP addresses Quinyx Web Services can be accessed for your data from in order to import or export data for their units. If you are repeatedly receiving HTTP Error 401 Method not allowed in your testing, please check with your Quinyx application administrator if an IP lockout has been imposed.

Programs for testing

For testing and troubleshooting we suggest using SoapUI or Postman, our example queries and responses are from SoapUI. If in contact with Quinyx always attach the request and response in .txt or similar format.


How Did We Do?