# 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.

This page covers the **legacy SOAP API**. For new integrations, consider the modern REST APIs:

- [Quinyx API v3](/api/v3) — current REST API
- [Quinyx API v2](/api/v2) — earlier REST API


## Before you start

You'll need:

- **An API key** — see [Authentication](/api/v1/authentication) for how to obtain one and how to send it on requests.
- **The correct environment** — RC for testing, Production for live data. See [Environments](#environments) below.


## Environments

### Release Candidate

Release candidate (RC) is our customer environment 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 at the start of each month and will overwrite all changes made in the RC environment.

- WSDL endpoint: [https://rc.quinyx.com/FlexForceWebServices.php](https://rc.quinyx.com/FlexForceWebServices.php)
- Web interface: [https://web-rc.quinyx.com](https://web-rc.quinyx.com)


### Production

This is the production environment.

- WSDL endpoint: [https://api.quinyx.com/FlexForceWebServices.php](https://api.quinyx.com/FlexForceWebServices.php)
- Web interface: [https://web.quinyx.com](https://web.quinyx.com)


Opening the WSDL endpoints in a web browser allows inspection of the available methods.

## 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 the scalability of our APIs while growing our customer and user base, we have restrictions on the usage of our SOAP APIs. These restrictions mean that we are enforcing 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. 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.**

For input parameters with `boolean` data types, the field must be presented with the xsi `boolean` datatype if true/false is to be used.

## Programs for testing

For testing and troubleshooting, we suggest using [SoapUI](https://www.soapui.org/) or [Postman](https://www.getpostman.com/). Our example queries and responses are from SoapUI. If in contact with Quinyx, always attach the request and response in `.txt` or similar format.

## TLS

All communication with Quinyx products is encrypted using TLS. To ensure all communication stays secure and your customer data is protected, Quinyx does not support any TLS protocol below version 1.2.

You can use our website [https://check.quinyx.com](https://check.quinyx.com) to verify your browser.

**Ciphers and TLS-versions will be applied.**

Quinyx API-Calls and web: TLS 1.2 with the following ciphers:

```text
ECDHE-ECDSA-AES128-GCM-SHA256
ECDHE-RSA-AES128-GCM-SHA256
ECDHE-ECDSA-AES128-SHA256
ECDHE-RSA-AES128-SHA256
ECDHE-ECDSA-AES128-SHA
ECDHE-RSA-AES128-SHA
ECDHE-ECDSA-AES256-GCM-SHA384
ECDHE-RSA-AES256-GCM-SHA384
ECDHE-ECDSA-AES256-SHA384
ECDHE-RSA-AES256-SHA384
ECDHE-RSA-AES256-SHA
ECDHE-ECDSA-AES256-SHA
```

Quinyx Images and assets: TLS 1.2 with the following ciphers:

```text
ECDHE-RSA-AES128-GCM-SHA256
ECDHE-RSA-AES128-SHA256
ECDHE-RSA-AES256-GCM-SHA384
ECDHE-RSA-AES256-SHA384
AES128-GCM-SHA256
AES256-GCM-SHA384
AES128-SHA256
```

## Next steps

- [Authenticate with your API key](/api/v1/authentication).
- Browse the operations in the sidebar — the SOAP renderer plugin generates one page per WSDL operation from `quinyx-flexforce.wsdl`.
- Download the raw [WSDL](/api/v1/services/FlexForce).
- Migrating? Start with the [Quinyx API v3](/api/v3), the modern REST API recommended for new integrations.