Skip to content

5. QRcode

Henry Chang edited this page Mar 20, 2016 · 5 revisions

GET /api/v1/accounts/{accountUuid}/customQrcodes/

  • 用途: retrieve list of user's qrcodes which contains customer's info
  • header:
    • apiKey(required)- refer to welcome page
    • token required
  • payload:
    • None
  • parameter:
    • η„‘
  • response: 200 OK
{
  "qrcodes": [
    {
      "id": "44800d97-9bfc-4c15-90a1-cad0514f7a7c",
      "userName": "123",
      "phoneNumber": "+88670707",
      "state": "enabled",
      "createdAt": 1458120459592,
      "updateAt": 1458120459592,
      "location": "mars",
      "company": "Google",
      "type": "special"
    }
  ]
}

POST /api/v1/accounts/{accountUuid}/customQrcodes/

  • 用途: add a user's qrcode which contains customer's info
  • header:
    • apiKey(εΏ…θ¦ηš„)- API ι‘°εŒ™
    • token required
  • payload:
{
    "name": "alphaGo",
    "phoneNumber":"+886975531888", (requried)
    "company":"Google Inc.",
    "location":"Hsinchu"

}
  • parameter:
    • η„‘
  • response: 200 OK 401 UNAUTHORIZED

DELETE/api/v1/accounts/{accountUuid}/customQrcodes/{qrcodeUUid}

  • 用途: delete a user's qrcode which contains customer's info
  • header:
    • apiKey(εΏ…θ¦ηš„)- API ι‘°εŒ™
    • token required
  • payload:
    • None
  • parameter:
    • η„‘
  • response: 200 OK 401 UNAUTHORIZED : δΈθ’«ζŽˆζ¬Šηš„ζ“δ½œ

PUT /api/v1/accounts/{accountUuid}/customQrcodes/

  • 用途: modify info of a user's qrcode which contains customer's info
  • header:
    • apiKey(εΏ…θ¦ηš„)- API ι‘°εŒ™
    • token required
  • payload:
{
    "name": "alphaGo",
    "phoneNumber":"+886975531888", (requried)
    "company":"Google Inc.",
    "location":"Hsinchu"

}
  • parameter:
    • η„‘
  • response: 200 OK 401 UNAUTHORIZED

GET /api/v1/qrcodes/{qrCodeuuid}/image

  • 用途: retrieve user's qrcodes image which contains customer's info
  • header:
    • apiKey(required)- refer to welcome page
  • payload:
    • None
  • parameter:
    • η„‘
  • response: 200 OK img/png 404 NOT FOUND

Clone this wiki locally