Web Services Intro

Uppdaterad 23/10/19 av Stephan Hale

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

RC

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.

Classic Web Interface: https://rc.quinyx.com

Neo Web Interface: https://web-rc.quinyx.com

Production

This is the production environment which is reached through

Classic Web Interface: https://app.quinyx.com

Neo Web Interface: https://web.quinyx.com

URLs for WebService API

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 organisation’s 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

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.


Fick du hjälp?