API - Getting started with our API

The QuenchTec API is based on REST principles, all you need to use it is your QuenchTec account. You need an API token to call requests on the URLs listed below. This documentation covers the core resources you can use to manipulate objects on the QuenchTec platform.

XML or JSON

QuenchTec API supports both XML and JSON languages for the REST protocol via content negotiation mechanism. XML is the default format but the client should still specify Accept HTTP header with value application/xml. 

Allowed HTTPs requests:

  • POST - Creates/updates a resource or sometimes to get specific resources 
  • PUT - Updates a resource
  • GET - Retrieves a resource or list of resources
  • DELETE - Delete a resource

Typical Server Responses

  • 200 OK - The request was successful.
  • 204 No Content - The request was successful but there is no representation to return (that is, the response is empty).
  • 400 Bad Request - The request could not be understood or was missing required parameters.
  • 401 Unauthorized - Authentication failed or user does not have permissions for the requested operation.
  • 403 Forbidden - Access denied.
  • 404 Not Found - Resource was not found.
  • 405 Method Not Allowed - Requested method is not supported for the specified resource.
  • 429 Too Many Requests - You are exceeding the QuenchTec API limits. Pause requests and try again. 
  • 503 Service Unavailable - The service is temporary unavailable (e.g. scheduled maintenance). Try again later.

Still need help? Contact Us Contact Us