ยืนยันตัวตนด้วย API key

ทุกคำขอไปยัง Checkslip API ต้องแนบ API key ของคุณ ออก key ได้ที่หน้า API key ในเว็บแอป

ส่ง API key#

แนบ key ใน header Authorization แบบ Bearer ทุกคำขอ key ของ Checkslip ขึ้นต้นด้วย csk_ และส่งผ่าน HTTPS เท่านั้น

Authorization: Bearer csk_…

curl https://api.checkslip.com/api/slips/lookup \
  -H "Authorization: Bearer $CHECKSLIP_API_KEY" \
  -H "Idempotency-Key: order-1042-slip-1" \
  -H "Content-Type: application/json" \
  -d '{"qr":"00330006000001010306902126302105340875102TH9104F86F"}'

const res = await fetch("https://api.checkslip.com/api/slips/lookup", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.CHECKSLIP_API_KEY}`,
    "Idempotency-Key": "order-1042-slip-1",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    qr: "00330006000001010306902126302105340875102TH9104F86F",
  }),
});
const data = await res.json();

import os

import requests

res = requests.post(
    "https://api.checkslip.com/api/slips/lookup",
    headers={
        "Authorization": f"Bearer {os.environ['CHECKSLIP_API_KEY']}",
        "Idempotency-Key": "order-1042-slip-1",
    },
    json={
        "qr": "00330006000001010306902126302105340875102TH9104F86F",
    },
)
data = res.json()

สิทธิ์ของ key#

ตอนออก key คุณเลือกได้ว่า key นั้นทำอะไรได้บ้าง ให้แต่ละ key มีเฉพาะสิทธิ์ที่ระบบของคุณใช้จริง

• สิทธิ์แต่ละตัวแยกกัน ไม่มีตัวไหนรวมอีกตัว เช่น slip:lookup ไม่ได้ให้ slip:read มาด้วย
• เปลี่ยนสิทธิ์ของ key ที่ออกแล้วไม่ได้ ถ้าต้องการสิทธิ์อื่น ให้ออก key ใหม่

เก็บ key ให้ปลอดภัย#

• เว็บแอปแสดงค่า key ทั้งหมดครั้งเดียวตอนออก คัดลอกไปเก็บทันที ถ้าทำหายให้ออก key ใหม่
• เก็บ key ไว้ฝั่งเซิร์ฟเวอร์ เช่น ตัวแปรสภาพแวดล้อมหรือที่เก็บความลับ อย่าใส่ในแอปมือถือ โค้ดหน้าเว็บ หรือ repository
• แยก key ตามระบบหรือสภาพแวดล้อม เพื่อเพิกถอนตัวเดียวได้โดยไม่กระทบที่อื่น
• key ที่ใช้งานได้สูงสุด 10 ตัวต่อบัญชี (ที่เพิกถอนหรือหมดอายุไม่นับ)

เปลี่ยน key#

1. ออก key ใหม่ในเว็บแอป
2. เปลี่ยนระบบของคุณให้ใช้ key ใหม่
3. เพิกถอน key เก่า

key ที่ถูกเพิกถอนหรือหมดอายุแล้วจะใช้ไม่ได้ภายใน 30 วินาที (ปกติทันที) และเปิดใช้กลับไม่ได้

เมื่อ key มีปัญหา#

คำขอที่ตอบด้วย error เหล่านี้ไม่หักเครดิต ดูทุกรหัสได้ที่ รหัสข้อผิดพลาด