How to: use RepairQ APIs for Qsite

Available with RepairQ 1.13

This article walks through the process of adding Qsite™ to your own company website, using RepairQ APIs. Keep in mind this is still in Beta, so you may come across bugs. This will allow your customers to click a link on your website, enter their ticket number and last name, and receive all of the information that is currently available with Qsite™.

Please be advised, this method is only recommended for use by web developers.

Given ticket number (env specific) and customer last name (to verify for semi-anonymous security):

GET​ ​https://​subdomain​.repairq.io/api/ticket/​number​?last_name=​name

E.g.:

GET ​https://staging2.repairq.io/api/ticket/69631?last_name=Rivera

Sample output, if found:

HTTP/1.1 200 OK
{"success":true,"message":"Record
Found","data":{"totalCount":1,"ticket":{"status":"closed","status_label":"Closed","sta
tus_updated_on":"2016-06-14 15:50:08","status_updated_on_str":"6\/14\/16 3:50 PM"}}}

Pretty printed:

{
  "success": true,
  "message": "Record Found",
  "data": {
    "totalCount": 1,
    "ticket": {
      "status": "closed",
      "status_label": "Closed",
      "status_updated_on": "2016-06-14 15:50:08",
      "status_updated_on_str": "6\/14\/16 3:50 PM"

} }

}

Not found or not matched:

HTTP/1.1 401 Not Authorized: Ticket not found or last_name does not match
{"success":false,"message":"Not Authorized: Ticket not found or last_name does not
match","data":{"errorCode":"401","message":"Not Authorized: Ticket not found or
last_name does not match"}}

Pretty printed:

{
  "success": false,
  "message": "Not Authorized: Ticket not found or last_name does not match",
  "data": {
    "errorCode": "401",
    "message": "Not Authorized: Ticket not found or last_name does not match"
  }

}

 

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk