ข้ามไปยังเนื้อหา

โทเค็นการเข้าถึง API

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

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

Anchor link to

Pushwoosh มี API Access Token สองประเภทที่แตกต่างกัน: Server และ Device

โทเค็นแต่ละประเภทจะใช้ได้เฉพาะกับขอบเขต API ของตัวเองเท่านั้น หากใช้โทเค็นที่ไม่ถูกต้อง จะเกิดข้อผิดพลาดในการยืนยันตัวตน

Server API token

Anchor link to

Server API token ใช้กับเมธอด API ทั้งหมด ยกเว้นเมธอดที่อยู่ภายใต้ Device API โทเค็นนี้ควรจะถูกรวมอยู่ในส่วน body ของ request ในฟิลด์ auth

Device API token

Anchor link to

Device API token ใช้สำหรับเมธอดของ Device API เท่านั้น โทเค็นนี้ควรจะถูกรวมอยู่ในเฮดเดอร์ของ HTTP request โดยใช้เฮดเดอร์ Authorization ด้านล่างนี้คือตัวอย่างรูปแบบเฮดเดอร์ที่ถูกต้อง:

Authorization: Token <device_api_token>

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

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

Anchor link to

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

โทเค็น Pushwoosh Demo App

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

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

Anchor link to

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

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

  2. คลิก Generate New Token

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

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

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

  4. ป้อนชื่อสำหรับโทเค็น

  5. คลิก Generate เพื่อสร้างโทเค็น

สร้างโทเค็นใหม่

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

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

จัดการโทเค็น

Anchor link to

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

จัดการโทเค็น

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

ให้สิทธิ์การเข้าถึงทุกโปรเจกต์

Anchor link to

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

เพิกถอนการเข้าถึงจากทุกโปรเจกต์

Anchor link to

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

แก้ไขโทเค็น

Anchor link to

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

  • เปลี่ยนชื่อโทเค็น

  • คัดลอกค่าโทเค็น

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

จัดการโทเค็น

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

ลบโทเค็น

Anchor link to

ลบโทเค็นออกจากบัญชีของคุณอย่างถาวร

การให้สิทธิ์คำขอ API

Anchor link to

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

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

Anchor link to

รวมโทเค็นไว้ในฟิลด์ “auth” ของ body ของ request: ตัวอย่าง:

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

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

Anchor link to

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

Authorization: Token <device_api_token>

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