API Access token

API Access Token คือตัวระบุที่ไม่ซ้ำกันซึ่งกำหนดให้กับโปรเจกต์ใดโปรเจกต์หนึ่งหรือหลายโปรเจกต์ในบัญชีของคุณ ใช้สำหรับยืนยันตัวตนบัญชีของคุณเพื่อจัดการโปรเจกต์ผ่าน API รวมถึงการแก้ไขบัญชี การส่งข้อความ การแก้ไขโปรเจกต์ ฯลฯ

ประเภทของ API Access token

Pushwoosh มี API Access Token สองประเภท: Server และ Device

Token แต่ละประเภทจะใช้ได้เฉพาะกับขอบเขต API ที่กำหนดเท่านั้น หากใช้ Token ผิดประเภทจะเกิดข้อผิดพลาดในการยืนยันตัวตน

Server API token

Server API token ใช้กับเมธอด API ทั้งหมด ยกเว้นเมธอดภายใต้ Device API โดยควรระบุไว้ใน request body ในฟิลด์ auth

Device API token

Device API token ใช้เฉพาะกับเมธอด Device API เท่านั้น โดยควรระบุไว้ใน HTTP request headers โดยใช้ header Authorization ด้านล่างนี้คือตัวอย่างรูปแบบ header ที่ถูกต้อง:

Authorization: Token <device_api_token>

แทนที่ \<device_api_token\> ด้วยค่า Device API Token จริงของคุณ

เมธอดที่ต้องใช้ Device API token

เมธอด API ต่อไปนี้ ต้องใช้ Device API token สำหรับการอนุญาต:

• registerDevice
• unregisterDevice
• setTags
• getTags
• setBadge
• applicationOpen
• pushStat
• messageDeliveryEvent
• registerUser
• postEvent
• registerEmail
• deleteEmail
• setEmailTags
• registerEmailUser
• getInboxMessages
• inboxStatus

สร้างและจัดการ API Access token

คุณสามารถดู สร้าง และจัดการ API Access token ของคุณได้ในส่วน API Access ของ Pushwoosh Control Panel ในการเข้าถึง ให้ไปที่ Settings → API Access

โดยค่าเริ่มต้น แต่ละบัญชีจะมี token ชื่อ Pushwoosh Demo App ซึ่งถูกตั้งค่าเป็น server token

สร้าง API Access token ใหม่

ในการสร้าง API Access token ใหม่:

1. ไปที่ส่วน API Access ใน Control Panel

2. คลิก Generate New Token

3. ในหน้าต่างที่ปรากฏขึ้น ให้เลือกประเภท token:

   • Server ใช้สำหรับเมธอด API ส่วนใหญ่ (ยกเว้นเมธอด Device API)

   • Device ใช้สำหรับเมธอด Device API เท่านั้น

4. ป้อนชื่อสำหรับ token

5. คลิก Generate เพื่อสร้าง token

สำคัญ: ตรวจสอบให้แน่ใจว่าได้ให้สิทธิ์การเข้าถึงแอปที่ถูกต้องแก่ token ใน Pushwoosh Control Panel ของคุณ เรียนรู้เพิ่มเติม

Token ใหม่จะปรากฏในรายการ API Access จากตรงนั้น คุณสามารถคัดลอกค่าเพื่อใช้ใน API request หรือจัดการสิทธิ์การเข้าถึงตามต้องการ

จัดการ token

ในการจัดการ API token ที่มีอยู่ ให้คลิก เมนูสามจุด (⋮) ถัดจากรายการ token ในส่วน API Access

มีตัวเลือกดังต่อไปนี้:

Grant access to all projects

ให้สิทธิ์ token เข้าถึงทุกโปรเจกต์ในบัญชีของคุณ สิ่งนี้ช่วยให้สามารถใช้ API ได้อย่างเต็มที่ในทุกโปรเจกต์

เคล็ดลับ

ให้สิทธิ์การเข้าถึงเต็มรูปแบบเฉพาะกับ token ที่จำเป็นต้องใช้เท่านั้น เพื่อช่วยรักษาความปลอดภัยของข้อมูลและควบคุมการเข้าถึง

Revoke access from all projects

ลบสิทธิ์การเข้าถึงของ token จากทุกโปรเจกต์ในบัญชีของคุณ Token จะไม่สามารถใช้ API ได้จนกว่าจะได้รับสิทธิ์อีกครั้ง

Edit token

เปิดหน้าจอ Edit API Token Permissions ซึ่งคุณสามารถ:

• เปลี่ยนชื่อ token

• คัดลอกค่า token

• เลือกโปรเจกต์ที่ token สามารถเข้าถึงได้โดยการเลือกหรือยกเลิกการเลือกในรายการ

หลังจากทำการเปลี่ยนแปลงเสร็จแล้ว ให้คลิก Save เพื่อนำไปใช้

เคล็ดลับ

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

Delete token

ลบ token ออกจากบัญชีของคุณอย่างถาวร

ข้อควรระวัง

การดำเนินการนี้ไม่สามารถยกเลิกได้ เมื่อลบแล้วจะไม่สามารถกู้คืน token ได้ ตรวจสอบให้แน่ใจว่าไม่ได้ใช้งาน token แล้วก่อนที่จะลบ

การอนุญาต API request

ในการอนุญาต API request ให้ใช้ประเภทของ API Access token ที่ถูกต้องตามประเภทของเมธอด API ที่คุณเรียกใช้:

สำหรับเมธอด Server API

รวม token ไว้ในฟิลด์ “auth” ของ request body:

ตัวอย่าง:

{
  "request": {
    "application": "XXXXX-XXXXX",
    "auth": "yxoPUlwqm…………pIyEX4H", // วาง server token ของคุณที่นี่
    "notifications": [{
      "send_date": "now",
      "content": "Hello world"
    }]
  }
}

สำหรับเมธอด Device API

ใช้ Device token โดยรวมไว้ใน HTTP request header โดยใช้รูปแบบต่อไปนี้:

Authorization: Token <device_api_token>

แทนที่ \<device_api_token\> ด้วยค่า token จริงของคุณ

ข้อควรระวัง

ตรวจสอบให้แน่ใจว่าประเภท token ตรงกับเมธอด API ที่คุณกำลังใช้ หาก token ไม่ตรงกับประเภทที่ต้องการ request จะส่งคืนข้อผิดพลาดในการยืนยันตัวตน