Quik! is planning to end support of Quik!’s SOAP API web services as of October 31, 2022. 

If you are a customer or partner that currently uses any of Quik!'s SOAP API web services, you will need to convert these to Quik!’s REST API web services.

By focusing our development efforts on our REST API offerings, we will be able to offer higher levels of security, increased uptime availability, and better performance.

We understand that many of our customers and partners are actively using our SOAP web services. We will work together to ensure the SOAP web services in use today will be completely available as REST web services after October 31, 2022.

Need Help?

We welcome your feedback, comments, and requests for help with this plan. Our goal is to move our technology and support forward as technology advances. If our timeframe is unattainable, please let us know so we can work with you to keep your system stable until you do move. In other words, we’re ready to talk about your specific needs and how best to meet them.

Advantages to Using REST

In addition to the standard items that come up when comparing SOAP to REST, the key advantages to using REST with Quik! are:

• Industry Standard - the software industry has largely left SOAP and moved to REST

• Easier to Authenticate - SOAP headers are challenging, whereas REST authentication is straight-forward (and more secure)

• Better Documentation - at Quik! we are enhancing our REST API documentation with a library of Postman scripts to make it easier to try out and test the APIs

• Single Platform - with our team focused only on REST we will have more resources to dedicate to making our APIs more robust and powerful

• Easier Upgrades - with REST we are able to upgrade the service more easily without creating new versions and endpoints

Migration Steps

High Level Steps

1. Identify the SOAP endpoints you currently use.

2. Match them to the REST endpoint to convert to.

3. Implement the REST endpoint
   (we know this is a huge step with re-factoring your code, so just know we’re not trying to oversimplify it)

4. Test in UAT environment

5. Go live

How To Implement REST

The REST services at Quik! all follow the same architecture and basic steps:

1. Authenticate - the first step to calling any REST API is to first call the authentication API and get an OAuth token. The token will be used with any subsequent API calls.

2. Call the API - Each API is documented and the parameters vary by endpoint

3. Do something with the data - Each API will return a set of results that include:

   1. ResultData object includes the returned values from the API

   2. ErrorCode to indicate a success (0) or failure (<> 0)

   3. Message to indicate the reason for failure

SOAP API --> REST API