Versions Compared

Key

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

PLEASE READ: All REST API endpoints must be in lower-case letters. Upper-case letters may cause latency or failure.

...

NOTE: Since Quik! was initially built upon SOAP APIs, not all APIs are available via REST yet. Please review the SOAP documentation for the service you're looking for if you don't see it in the REST API list. 

Using Quik! REST API's

Inline Documentation

All REST services have an inline documentation tool called "Swagger" to make it easy to view and test the services. Each service's parameters are well documented and accessible by adding "/swagger" to any REST end point (excluding the end-points parameters). Using Swagger you can login to create an OAuth2 token and then test the service (the OAuth token is managed in the background). 

...

Service parameters are listed in the Parameters section and indicate their requirements. 

REST Authentication

All of Quik!'s REST API's rely upon an OAuth2 Token authentication methodology. Each call to a Quik! resource will require a valid, unexpired OAuth2 Token that must be passed in the Authentication Header of the resource's request.

...

Header Value: Bearer {{Quik! OAuth Token}}  (For example, "Bearer cSEKkmV3bGGpYjfGDlQ87DI37HtI5YYMg...")


You may be able to use a single token multiple times across different service depending on the duration of the token and whether it can be regenerated. In case a request to any of our APIs returns a 401 Unauthorized error, then it means that the Quik! OAuth token expired or is invalid, so a new one must be generated.

NOTE: Tokens expire after 1 hour.

How to Get a Quik! OAuth Token

In order to get a token, it's as simple as making the following POST request:

REST Authentication Server Endpointhttps://websvcs.quikforms.com/rest_authentication/token

Http Method - POST

Content-Type - application/x-www-form-urlencoded

Body - grant_type=password&username={{Quik! Username}}&password={{Quik! Password}}

...