สร้างและจัดการ API Key ของคุณ

Published: 16 กรกฎาคม 2569 · Last updated: 21 กรกฎาคม 2569 · By Marcus Biel

หน้า API Key ช่วยให้ระบบภายนอกเข้าถึงปลายทาง Maildroppa API ที่รองรับในบัญชีของคุณได้ผ่านการยืนยันตัวตน

คุณสามารถสร้าง API key ได้หนึ่งรายการ คัดลอกค่าลับทั้งหมดของคีย์ รีเซ็ตอย่างปลอดภัยด้วยการหมุนเวียนคีย์ หรือลบคีย์เมื่อไม่จำเป็นต้องใช้อีกต่อไป API key เดียวกันของบัญชีสามารถใช้ได้ทั้งการเชื่อมต่อฝั่งเซิร์ฟเวอร์และทริกเกอร์คำขอ API ใน Maildroppa Automations

API key ใช้แทนบัญชี Maildroppa ของคุณ ให้ปฏิบัติต่อคีย์นี้เหมือนรหัสผ่าน: ผู้ใดก็ตามที่ได้คีย์ไปจะสามารถเรียกใช้ปลายทาง API ที่คีย์นั้นเข้าถึงได้ จนกว่าคุณจะหมุนเวียนหรือลบคีย์

API Key ใช้ทำอะไร

ใช้ API key เมื่อซอฟต์แวร์ภายนอก Maildroppa จำเป็นต้องทำงานร่วมกับ Maildroppa โดยไม่ต้องเข้าสู่ระบบผ่านผู้ใช้แบบโต้ตอบ

ตัวอย่างการใช้งานทั่วไป ได้แก่:

• ซิงโครไนซ์ผู้สมัครสมาชิกกับ CRM ร้านค้า ระบบสมาชิก หรือฐานข้อมูลภายใน
• สร้างหรืออัปเดตผู้สมัครสมาชิกจากแอปพลิเคชันฝั่งเซิร์ฟเวอร์
• อ่านหรือจัดการแท็ก ฟิลด์ ค่าฟิลด์ และเซกเมนต์ผ่านปลายทางที่รองรับ
• ส่งเหตุการณ์แบบกำหนดเองไปยังทริกเกอร์คำขอ API ใน Automation
• ส่ง Email Messages แบบธุรกรรมผ่าน API
• จัดการการสมัครรับ webhook ที่ทำงานผ่าน API

API key มีไว้สำหรับการสื่อสารระหว่างเซิร์ฟเวอร์ ไม่ได้มีไว้สำหรับโค้ดที่ทำงานในเบราว์เซอร์ของผู้เข้าชม เว็บไซต์สาธารณะ แอปพลิเคชันมือถือ หรือแบบฟอร์มสมัครสมาชิกที่ฝังไว้

ขณะนี้หน้านี้มีป้ายกำกับ “beta” ให้ใช้เอกสาร OpenAPI ที่ลิงก์ไว้เป็นแหล่งข้อมูลสำหรับปลายทาง เนื้อหาคำขอ พารามิเตอร์ และสคีมาตอบกลับที่ API รองรับในปัจจุบัน

การเปิดหน้า API Key

เปิด “Settings” ขยาย “Developers” แล้วเลือก “API key”

คุณยังสามารถเปิดหน้าโดยตรงได้ที่:

https://app.maildroppa.com/settings/developers/api-key

หน้านี้ประกอบด้วย:

• แผง API key พร้อมป้าย beta
• ลิงก์ “View OpenAPI docs”
• สถานะว่างและปุ่ม “Create API key” เมื่อยังไม่มีคีย์
• การแสดงคีย์ปัจจุบันแบบปิดบังเมื่อมีคีย์อยู่
• ปุ่ม “Copy” สำหรับคัดลอกคีย์ทั้งหมด
• การดำเนินการ “Rotate API key” และ “Delete API key” เพื่อแทนที่หรือลบคีย์ปัจจุบัน

Maildroppa อนุญาตให้มี API key ได้หนึ่งรายการต่อบัญชี หน้านี้จะไม่สร้างคีย์แยกสำหรับแอปพลิเคชัน สภาพแวดล้อม หรือสมาชิกทีมแต่ละราย

การสร้าง API Key

เมื่อหน้าแสดง “No API key yet” ให้คลิก “Create API key”

Maildroppa จะสร้างคีย์ทันที โดยไม่มีหน้าต่างยืนยันสำหรับการสร้างครั้งแรก ระหว่างที่คำขอกำลังทำงาน ปุ่มจะเปลี่ยนเป็น “Creating API key” และหน้าจะปิดใช้งานการดำเนินการเกี่ยวกับคีย์เพิ่มเติมชั่วคราว

หลังจากสร้างคีย์แล้ว:

• สถานะว่างจะหายไป
• คีย์แบบปิดบังจะปรากฏขึ้น
• การดำเนินการ “Copy”, “Rotate API key” และ “Delete API key” จะพร้อมใช้งาน
• Maildroppa จะแสดงข้อความสำเร็จ “API key updated”

หากมีคีย์อื่นอยู่แล้วสำหรับบัญชี Maildroppa จะไม่สร้างคีย์ที่สอง ให้ใช้คีย์เดิมหรือหมุนเวียนคีย์นั้น

ทำความเข้าใจคีย์แบบปิดบัง

หน้าจะไม่แสดงค่าลับทั้งหมดเป็นข้อความปกติ แต่จะแสดงอักขระห้าตัวแรกตามด้วยเครื่องหมายดอกจันห้าตัว เช่น:

a1b2c*****

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

คลิก “Copy” เพื่อเขียนคีย์ปัจจุบันทั้งหมดลงในคลิปบอร์ด หลังจากคัดลอกสำเร็จ ปุ่มจะเปลี่ยนเป็น “Copied!” ชั่วครู่

คีย์จะยังคงถูกปิดบังเมื่อคุณกลับมาที่หน้าเดิม แต่ “Copy” จะยังคงคัดลอกค่าปัจจุบันทั้งหมด ดังนั้นคุณไม่จำเป็นต้องหมุนเวียนคีย์ที่ยังใช้งานได้ เพียงเพราะไม่ได้บันทึกคีย์ไว้ตอนสร้าง

การจัดเก็บคีย์อย่างปลอดภัย

ย้ายคีย์ที่คัดลอกไว้โดยตรงไปยังพื้นที่จัดเก็บข้อมูลลับที่การเชื่อมต่อใช้งาน

ตำแหน่งที่เหมาะสม ได้แก่:

• ตัวจัดการข้อมูลลับที่มีการจัดการดูแล
• การกำหนดค่าสภาพแวดล้อมของเซิร์ฟเวอร์ที่ได้รับการป้องกัน
• ข้อมูลลับสำหรับการดีพลอยที่เข้ารหัสไว้
• ตัวจัดการรหัสผ่านที่ใช้สำหรับการกู้คืนด้านปฏิบัติการ

อย่าจัดเก็บคีย์ไว้ใน:

• JavaScript ฝั่งเบราว์เซอร์หรือ frontend bundle อื่นที่สามารถดาวน์โหลดได้
• ไฟล์ซอร์สโค้ดสาธารณะหรือส่วนตัวที่ commit ไว้ใน repository
• URL หรือพารามิเตอร์ query
• เอกสารสาธารณะ ภาพหน้าจอ ข้อความถึงฝ่ายสนับสนุน หรือระบบติดตามปัญหา
• บันทึกแอปพลิเคชัน เหตุการณ์วิเคราะห์ข้อมูล หรือรายงานข้อผิดพลาดที่ใช้ร่วมกัน
• สเปรดชีตที่ไม่ได้เข้ารหัสหรือแชตทีมทั่วไป

อย่าใส่คีย์ในตัวอย่าง curl ที่จะถูกคัดลอกไปไว้ในเอกสารหรือประวัติ shell ที่แชร์กับผู้อื่น ควรใช้ตัวแปรสภาพแวดล้อม เช่น MAILDROPPA_API_KEY

การใช้ API Key

ส่งคีย์ทั้งหมดในส่วนหัวคำขอ HTTP X-API-Key:

X-API-Key: your-complete-api-key

อย่าส่งคีย์เป็น Bearer token Maildroppa ต้องการ X-API-Key ไม่ใช่ Authorization: Bearer ...

Production API และเอกสาร OpenAPI แบบโต้ตอบมีให้บริการที่:

https://api.maildroppa.com

คลิก “View OpenAPI docs” บนหน้า API Key เพื่อเปิดเอกสารในแท็บเบราว์เซอร์ใหม่ เลือกปลายทางที่ต้องการเพื่อตรวจสอบเมธอด พาธ พารามิเตอร์ เนื้อหาคำขอ ประเภทการตอบกลับ และรหัสสถานะที่อาจเกิดขึ้น

ตัวอย่างคำขอ

ตัวอย่างต่อไปนี้ดึงหน้าผู้สมัครสมาชิกหน้าแรก โดยอ่านคีย์จากตัวแปรสภาพแวดล้อมแทนการใส่ข้อมูลลับลงในคำสั่งโดยตรง:

curl --request GET \
  --url 'https://api.maildroppa.com/subscribers?pageNumber=1' \
  --header 'Accept: application/json' \
  --header "X-API-Key: ${MAILDROPPA_API_KEY}"

กำหนดตัวแปรในสภาพแวดล้อมที่ปลอดภัยซึ่งการเชื่อมต่อทำงานอยู่ เมธอด พาธ พารามิเตอร์ query และเนื้อหาคำขอที่แน่นอนจะขึ้นอยู่กับปลายทาง ให้คัดลอกรายละเอียดเหล่านั้นจากเอกสาร OpenAPI แทนการคาดเดาจากการดำเนินการที่มีอยู่ในแอปพลิเคชัน Maildroppa

คำขอที่มีเนื้อหา JSON

สำหรับคำขอที่ส่ง JSON ให้ใส่สิ่งต่อไปนี้เพิ่มเติม:

Content-Type: application/json

ตัวอย่างโครงสร้างพื้นฐานคือ:

curl --request POST \
  --url 'https://api.maildroppa.com/example-endpoint' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-API-Key: ${MAILDROPPA_API_KEY}" \
  --data '{"example":"value"}'

/example-endpoint และเนื้อหาของคำขอเป็นเพียงตัวแทนค่า ให้แทนที่ด้วยปลายทางและสคีมาคำขอที่มีการระบุไว้ในเอกสาร

คีย์เข้าถึงอะไรได้บ้าง

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

เอกสาร OpenAPI แสดง customer API ที่รองรับ หากพาธใดไม่ได้ระบุว่าใช้งานด้วย API key อย่าสันนิษฐานว่าคีย์จะเข้าถึงพาธนั้นได้

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

ขีดจำกัดอัตราการร้องขอ

สัญญา OpenAPI ปัจจุบันระบุขีดจำกัดสำหรับ API key ดังนี้:

• Default customer API: 300 คำขอต่อนาที และ 2,000 คำขอต่อชั่วโมง
• Events API ที่ /events: 100 คำขอต่อวินาที โดยมีความจุสำหรับ burst 500 คำขอ

ขีดจำกัดเหล่านี้ใช้กับบัญชี Maildroppa ไม่ได้แยกใช้กับสคริปต์แต่ละรายการที่แชร์คีย์เดียวกัน ดังนั้นการเชื่อมต่อหลายรายการอาจใช้โควตาเดียวกัน

เมื่อ Maildroppa ส่งกลับ 429 Too Many Requests ให้หยุดส่งคำขอใหม่และปฏิบัติตามส่วนหัวตอบกลับ Retry-After หากมี ใช้คิวและการหน่วงเวลาย้อนกลับที่ควบคุมได้ แทนการเริ่มลองใหม่พร้อมกันจำนวนมาก

นโยบายจำกัดอัตราการร้องขออาจเปลี่ยนแปลงได้ขณะที่ API ยังอยู่ในรุ่น beta ตรวจสอบข้อมูลด้านบนของเอกสาร OpenAPI ก่อนออกแบบการเชื่อมต่อที่มีปริมาณการใช้งานสูง

การใช้คีย์สำหรับคำขอ Automation API

Automation สามารถเริ่มทำงานเมื่อระบบของคุณส่งเหตุการณ์แบบกำหนดเองไปยัง Maildroppa's Events API

เมื่อคุณกำหนดค่าทริกเกอร์ “API request” Maildroppa จะใช้ API key เดียวกันของบัญชีที่จัดการในหน้านี้ การตั้งค่าทริกเกอร์สามารถสร้างคีย์เมื่อยังไม่มี และสามารถคัดลอกคำขอ curl ที่เตรียมไว้ซึ่งมีคีย์ทั้งหมด

สิ่งนี้มีผลสำคัญสองประการ:

• การหมุนเวียนหรือลบคีย์ของบัญชีจะส่งผลต่อระบบที่ส่งเหตุการณ์แบบกำหนดเองไปยัง Automations ด้วย
• ตัวอย่างคำขอ Automation ที่คัดลอกจะมีข้อมูลลับอยู่ในคลิปบอร์ด แม้ว่าคีย์จะถูกปิดบังบนหน้าจอ

ก่อนหมุนเวียนหรือลบคีย์ ให้รวมทริกเกอร์คำขอ API ทุกตัวและผู้ส่งเหตุการณ์ภายนอกทุกตัวไว้ในรายการการเชื่อมต่อของคุณ

การรีเซ็ตหรือแทนที่ API Key

ใช้ “Rotate API key” เมื่อต้องการรีเซ็ตหรือแทนที่ข้อมูลรับรองปัจจุบัน Maildroppa จะสร้างคีย์ใหม่และทำให้คีย์เดิมใช้งานไม่ได้เป็นส่วนหนึ่งของการดำเนินการเดียวกัน

ใช้การหมุนเวียนคีย์เมื่อ:

• คีย์อาจรั่วไหล
• บุคคลหรือผู้ให้บริการที่ทราบคีย์ไม่จำเป็นต้องเข้าถึงอีกต่อไป
• นโยบายความปลอดภัยของคุณกำหนดให้เปลี่ยนข้อมูลรับรองเป็นระยะ
• คุณต้องการแทนที่คีย์ที่จัดเก็บไว้ในตำแหน่งเก่าหรือไม่ปลอดภัย

คลิก “Rotate API key” ใต้คีย์แบบปิดบัง Maildroppa จะเปิดกล่องโต้ตอบคำเตือนที่อธิบายว่าคีย์เดิมจะไม่สามารถใช้งานได้อีกต่อไป

คลิก “Rotate API key” ในกล่องโต้ตอบเพื่อดำเนินการต่อ หรือคลิก “Cancel” เพื่อเก็บคีย์ปัจจุบันไว้

การหมุนเวียนคีย์ไม่มีช่วงผ่อนผัน

หลังจากยืนยันการหมุนเวียนคีย์ คีย์เดิมจะหยุดทำงานทันที Maildroppa จะไม่ทำให้คีย์เดิมและคีย์ใหม่ใช้งานได้พร้อมกัน

เนื่องจากบัญชีมีคีย์ได้เพียงหนึ่งรายการ การหมุนเวียนจึงส่งผลต่อเซิร์ฟเวอร์ งานตามกำหนดเวลา การเชื่อมต่อ สคริปต์ และผู้ส่งเหตุการณ์ Automation ทุกตัวที่ใช้คีย์นั้น

ใช้ลำดับต่อไปนี้สำหรับการหมุนเวียนคีย์ตามแผน:

1. จัดทำรายการการเชื่อมต่อทุกตัวที่ใช้คีย์ปัจจุบัน
2. เตรียมการเข้าถึงการกำหนดค่าข้อมูลลับและกระบวนการดีพลอยของการเชื่อมต่อแต่ละรายการ
3. เลือกช่วงเวลาบำรุงรักษาสั้น ๆ หากการเข้าถึง API อย่างต่อเนื่องเป็นเรื่องสำคัญ
4. คลิก “Rotate API key” จากนั้นยืนยันคำเตือนด้วย “Rotate API key” ในกล่องโต้ตอบ
5. คลิก “Copy” เพื่อคัดลอกคีย์ใหม่ทั้งหมด
6. แทนที่ข้อมูลลับในการเชื่อมต่อทุกตัวทันที
7. รีสตาร์ตหรือดีพลอยบริการที่โหลดข้อมูลลับเฉพาะตอนเริ่มต้น
8. ส่งคำขอที่มีการระบุไว้และไม่ก่อให้เกิดผลกระทบเพื่อยืนยันการเชื่อมต่อแต่ละรายการ
9. ตรวจสอบการตอบกลับ 401 Unauthorized จากบริการที่ถูกลืมและยังใช้คีย์เดิม

หากเชื่อว่าคีย์ปัจจุบันถูกบุกรุก ให้หมุนเวียนคีย์ทันทีและยอมรับการหยุดชะงักช่วงสั้น ๆ ที่จำเป็นต่อการอัปเดตระบบที่ถูกต้องตามกฎหมาย

การลบ API Key

ลบคีย์เมื่อบัญชีไม่ควรยอมรับคำขอที่ยืนยันตัวตนด้วย API key อีกต่อไป

คลิก “Delete API key” ใต้คีย์แบบปิดบัง Maildroppa จะเปิดกล่องโต้ตอบคำเตือนที่อธิบายว่าคีย์จะถูกลบออกจากบัญชีอย่างถาวร

คลิก “Delete API key” ในกล่องโต้ตอบเพื่อลบคีย์ หรือคลิก “Cancel” เพื่อเก็บคีย์ไว้

หลังจากลบแล้ว:

• คีย์ปัจจุบันจะหยุดทำงานทันที
• หน้าจะกลับไปยังสถานะ “No API key yet”
• การเชื่อมต่อเซิร์ฟเวอร์ที่ใช้คีย์ที่ถูกลบจะไม่สามารถยืนยันตัวตนได้อีกต่อไป
• ผู้ส่งคำขอ Automation API ที่ใช้คีย์นั้นจะไม่สามารถส่งเหตุการณ์ได้อีกต่อไป

การลบคีย์จะไม่ลบผู้สมัครสมาชิก แคมเปญ แท็ก ฟิลด์ เซกเมนต์ Automations หรือข้อมูลบัญชีอื่น ๆ แต่จะลบข้อมูลรับรองที่ใช้เข้าถึงปลายทาง API ที่รองรับ

คุณสามารถคลิก “Create API key” ในภายหลังเพื่อสร้างข้อมูลรับรองใหม่ ค่าที่ถูกลบจะไม่ถูกกู้คืน การเชื่อมต่อทุกตัวต้องได้รับการอัปเดตก่อนจึงจะใช้คีย์ใหม่ได้

ควรรีเซ็ตหรือลบ: เลือกอย่างไหนดี?

เลือก “Rotate API key” เมื่อควรให้การเข้าถึง API ดำเนินต่อด้วยข้อมูลรับรองใหม่

เลือกการลบเมื่อควรหยุดการเข้าถึง API โดยสมบูรณ์ อย่างน้อยในช่วงเวลานี้

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

คำแนะนำด้านความปลอดภัย

ให้การเรียก API ทำงานบนเซิร์ฟเวอร์ของคุณ

เบราว์เซอร์หรือแอปมือถือไม่สามารถเก็บข้อมูลลับที่ฝังไว้ได้อย่างน่าเชื่อถือ ผู้ใช้สามารถตรวจสอบแอปพลิเคชัน ส่วนหัวคำขอ source maps หรือทราฟฟิกเครือข่ายและดึงคีย์ออกมาได้

หากเว็บไซต์หรือแอปจำเป็นต้องทริกเกอร์การดำเนินการ ให้ส่งคำขอไปยัง backend ที่ผ่านการยืนยันตัวตนของคุณเองก่อน ให้ backend นั้นตรวจสอบผู้ใช้และเรียก Maildroppa โดยใช้คีย์ที่จัดเก็บบนเซิร์ฟเวอร์

ลดการเปิดเผยให้เหลือน้อยที่สุด

มอบคีย์ให้เฉพาะระบบที่จำเป็นต้องใช้ อย่าแจกจ่ายให้ผู้พัฒนาทุกคนหรือวางไว้ในไฟล์กำหนดค่าภายในเครื่องหลายแห่ง

เนื่องจากขณะนี้หน้าดังกล่าวจัดการคีย์เดียวทั่วทั้งบัญชีแทนที่จะเป็นคีย์หลายรายการที่ตั้งชื่อหรือกำหนดขอบเขต หากหลายแอปพลิเคชันต้องการการแยกออกจากกันที่เข้มงวดยิ่งขึ้น ให้ใช้บริการเชื่อมต่อภายในหรือพร็อกซี

ปกปิดส่วนหัวคำขอ

กำหนดค่าไคลเอ็นต์ HTTP reverse proxy เครื่องมือสังเกตการณ์ระบบ และตัวรายงานข้อผิดพลาดให้ปกปิด X-API-Key คำขออาจทำงานได้ถูกต้อง แต่ยังคงทำให้ข้อมูลรับรองรั่วไหลผ่านบันทึกการดีบัก

แยกสภาพแวดล้อมออกจากกัน

อย่านำ production key กลับมาใช้ในการพัฒนาภายในเครื่อง โค้ดตัวอย่าง ภาพหน้าจอ หรือชุดทดสอบ จัดเก็บข้อมูลลับเฉพาะสภาพแวดล้อมไว้ในพื้นที่จัดเก็บข้อมูลลับของสภาพแวดล้อมนั้น

ลิงก์ “View OpenAPI docs” จะนำผู้ใช้ production ไปยังเอกสาร production API โดยอัตโนมัติ ตรวจสอบชื่อโฮสต์ก่อนส่งคีย์จริงทุกครั้ง

หมุนเวียนคีย์หลังสงสัยว่ามีการเปิดเผย

การลบข้อความ commit ของ repository บรรทัดในบันทึก หรือภาพหน้าจอไม่ได้พิสูจน์ว่าไม่มีใครคัดลอกคีย์ หากค่าทั้งหมดถูกเปิดเผย ให้หมุนเวียนคีย์

การจัดการข้อผิดพลาดของ API

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

กรณีทั่วไป ได้แก่:

• 400 Bad Request — พาธ พารามิเตอร์ หรือเนื้อหา JSON ไม่เป็นไปตามสัญญาของปลายทาง เปรียบเทียบคำขอกับสคีมา OpenAPI
• 401 Unauthorized — ไม่มีส่วนหัว X-API-Key ส่วนหัวว่างเปล่า ไม่ถูกต้อง ถูกลบ หรือมีค่าเก่าหลังการหมุนเวียนคีย์
• 403 Forbidden — คีย์ที่ผ่านการยืนยันตัวตนไม่ได้รับอนุญาตให้ใช้การดำเนินการนั้น
• 404 Not Found — ไม่มีพาธหรือทรัพยากรที่อ้างถึงในบัญชีนี้
• 429 Too Many Requests — การเชื่อมต่อถึงขีดจำกัดอัตราการร้องขอ API ให้หยุดคำขอและปฏิบัติตามส่วนหัว Retry-After หากมี
• 5xx — Maildroppa ไม่สามารถดำเนินการคำขอให้เสร็จสมบูรณ์ ลองดำเนินการที่ปลอดภัยใหม่ด้วย exponential backoff ที่มีขอบเขต และบันทึกข้อมูลโดยไม่รวม API key

อย่าลองใหม่ทุกกรณีโดยไม่ตรวจสอบ แก้ไขการตอบกลับ 400, 401, 403 และการตอบกลับ 404 ส่วนใหญ่ก่อนส่งคำขอเดิมอีกครั้ง

สำหรับคำขอที่เปลี่ยนแปลงข้อมูล ให้ยืนยันพฤติกรรมการลองใหม่และ idempotency ของปลายทางก่อนทำซ้ำโดยอัตโนมัติ การเชื่อมต่อล้มเหลวไม่ได้พิสูจน์เสมอไปว่า Maildroppa ไม่ได้เปลี่ยนแปลงข้อมูล

การแก้ไขปัญหา

ยังคงเห็น “Create API key” อยู่

ขณะนี้บัญชียังไม่มีคีย์ คลิกปุ่มหนึ่งครั้งและรอให้คำขอเสร็จสิ้น

หากการสร้างล้มเหลว ให้โหลดหน้าใหม่ก่อนลองอีกครั้ง หน้าอื่นหรือการตั้งค่า Automation อาจสร้างคีย์ของบัญชีไปแล้ว

คีย์บนหน้าดูสั้นเกินไป

หน้าจะแสดงอักขระห้าตัวแรกและ ***** โดยตั้งใจ คลิก “Copy” เพื่อคัดลอกค่าทั้งหมด อย่าส่งข้อความที่ปิดบังแล้วในคำขอ

“Copy” ไม่เปลี่ยนเป็น “Copied!”

เบราว์เซอร์อาจบล็อกการเข้าถึงคลิปบอร์ด ให้หน้าอยู่ในแท็บที่ใช้งานอยู่ อนุญาตการเข้าถึงคลิปบอร์ดหากมีการร้องขอ แล้วคลิก “Copy” อีกครั้ง

อย่าพยายามสร้างคีย์ขึ้นใหม่จากข้อความที่ปิดบัง

คำขอส่งกลับ 401 Unauthorized

ตรวจสอบว่า:

• ชื่อส่วนหัวคือ X-API-Key ตรงตามนี้ทุกตัวอักษร
• ส่วนหัวมีค่าทั้งหมด โดยไม่มีเครื่องหมายดอกจันที่มองเห็นได้
• การเชื่อมต่อไม่ได้ส่ง Authorization: Bearer แทน
• ไม่มีการเพิ่มช่องว่าง เครื่องหมายอัญประกาศ หรือขึ้นบรรทัดใหม่ในข้อมูลลับ
• ไม่มีผู้ใดหมุนเวียนหรือลบคีย์ของบัญชี
• มีการรีสตาร์ตบริการแล้ว หากบริการอ่านตัวแปรสภาพแวดล้อมเฉพาะตอนเริ่มต้น
• คำขอถูกส่งไปยังสภาพแวดล้อม Maildroppa API ที่ถูกต้อง

การเชื่อมต่อหนึ่งรายการทำงาน แต่อีกรายการหยุดทำงานหลังการหมุนเวียนคีย์

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

หน้า OpenAPI ใช้งานได้ แต่ปลายทางส่งกลับ 403

ปลายทางของแอปพลิเคชันไม่ใช่ทุกตัวที่รองรับการยืนยันตัวตนด้วย API key ให้ใช้การดำเนินการที่มีการระบุไว้สำหรับ customer API และยืนยันข้อกำหนดการยืนยันตัวตนในหน้า OpenAPI

คำขอส่งกลับ 429 Too Many Requests

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

รายการตรวจสอบการตั้งค่าที่แนะนำ

ก่อนนำการเชื่อมต่อไปใช้งานเป็นประจำ ให้ยืนยันว่า:

• คีย์จัดเก็บไว้เฉพาะในการกำหนดค่าข้อมูลลับฝั่งเซิร์ฟเวอร์
• คำขอใช้ส่วนหัว X-API-Key
• การเชื่อมต่อใช้ https://api.maildroppa.com ใน production
• เมธอด พาธ พารามิเตอร์ และเนื้อหา JSON ทุกอย่างเป็นไปตามเอกสาร OpenAPI
• บันทึกและรายงานข้อผิดพลาดปกปิดคีย์
• มีการกำหนด timeout และการลองใหม่ที่มีขอบเขต
• มีการเฝ้าติดตามข้อผิดพลาด 401, 403, 429 และข้อผิดพลาดของเซิร์ฟเวอร์
• มีการบันทึกผู้รับผิดชอบการเชื่อมต่อ
• ทุกระบบที่แชร์คีย์ของบัญชีรวมอยู่ในแผนการหมุนเวียนคีย์
• สามารถหมุนเวียนคีย์ที่ถูกบุกรุกได้อย่างรวดเร็ว

หน้า API Key มีขนาดเล็กโดยตั้งใจ แต่การดำเนินการในหน้านี้ส่งผลต่อการเชื่อมต่อ API ทุกตัวที่เชื่อมโยงกับบัญชี สร้างคีย์เฉพาะเมื่อจำเป็น เก็บไว้บนเซิร์ฟเวอร์ที่เชื่อถือได้ และวางแผนการหมุนเวียนในฐานะการเปลี่ยนแปลงข้อมูลรับรองทั่วทั้งบัญชี