Back to top

Privage API

สามารถเชื่อมต่อกับระบบ Privage โดยใช้ API ได้

การเชื่อมต่อ

ในการเรียกใช้งาน API จะต้องใช้ API Key ในการ Authorize คุณสามารถดู API Key ของคุณได้จาก Privage Back Office

curl -X GET 
    -H "Authorize-Key:{API Key}" \
    -H "Content-Type: application/json" \
    https://service.privageapp.com/remote/api/read_data

หากไม่สามารถเรียกใช้งานได้ จะมี Error 403 ส่งกลับมา

{
  "detail": "invalid authorize key"
}

สมาชิก

ข้อมูลสมาชิก

แสดงข้อมูลสมาชิก

ดูข้อมูลสมาชิก
GET/member/{id}

เรียกดูข้อมูลบัตรสมาชิกที่ตาม Member ID

Example URI

GET https://service.privageapp.com/remote/api/member/10000012
URI Parameters
HideShow
id
string (required) Example: 10000012

Member ID

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
    "status": "ok",
    "results": {
        "birthday": "",
        "name": "John Doh",
        "zip": "",
        "address": "",
        "mobile": "02-222-2222",
        "gender": "male",
        "profile_image": "",
        "email": "privageapp@gmail.com",
        "card": {
            "expired": "2015-11-21T04:00:00+00:00",
            "total_price": 1580,
            "type": 1,
            "card_id": "99999999",
            "point": 158
            }
        }
    }
}

การให้คะแนน

การให้คะแนนสมาชิก

จัดการคะแนน

ดูคะแนนล่าสุด
GET/update_point/

เรียกดูคะแนนที่เพิ่มในระบบล่าสุด

Example URI

GET https://service.privageapp.com/remote/api/update_point/
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ok",
  "results": [
    {
      "reference": "",
      "point": 25,
      "created_at": "2016-11-08T08:12:31+00:00",
      "branch": "",
      "total": 1000,
      "transaction_id": 175
    }
  ]
}

เพิ่มคะแนน
POST/update_point/

เพิ่มคะแนนให้กับลูกค้า

Example URI

POST https://service.privageapp.com/remote/api/update_point/
Request
HideShow
Headers
Content-Type: application/json
Body
{
  "member_id": "10000012",
  "machine": "POS1",
  "bill_total": 1590,
  "bill_reference": "INV1234",
  "bill_branch": "Bangkok"
}
Schema
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "type": "object",
  "properties": {
    "member_id": {
      "type": "string",
      "description": "Member ID"
    },
    "machine": {
      "type": "string",
      "description": "POS Reference (ชื่อเครื่อง POS)"
    },
    "bill_total": {
      "type": "number",
      "description": "Bill Total (ยอดบิลที่จ่าย)"
    },
    "bill_reference": {
      "type": "string",
      "description": "Reference (รหัสอ้างอิง, เลขที่ใบเสร็จ)"
    },
    "bill_branch": {
      "type": "string",
      "description": "Branch (สาขาที่ใช้บริการ)"
    }
  },
  "required": [
    "member_id",
    "machine",
    "bill_total"
  ]
}
Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ok",
  "results": {
    "transaction_id": 177,
    "point": "25"
  }
}

ยกเลิกการให้คะแนน
DELETE/update_point/{transaction_id}

ยกเลิกการให้คะแนนที่ให้

Example URI

DELETE https://service.privageapp.com/remote/api/update_point/1
URI Parameters
HideShow
transaction_id
number (required) Example: 1

รหัส Transaction ID ที่ได้รับตอนให้คะแนน

Response  200
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "ok",
  "results": {
    "message": "done"
  }
}
Response  400
HideShow
Headers
Content-Type: application/json
Body
{
  "status": "error",
  "results": {
    "message": "incomplete"
  }
}

Generated by aglio on 08 Nov 2016