สำหรับผู้พัฒนาเว็บไซต์
API สาธารณะทำอะไรได้ คีย์ทำงานอย่างไร ทำไมออเดอร์ซ้ำกันไม่ได้ และขอสเปกฉบับเต็มได้อย่างไร
หน้านี้สำหรับคนที่ทำหน้าร้านออนไลน์ ที่นี่มีแนวทางและกฎ ส่วน สเปกฉบับเต็มพร้อมที่อยู่ของเมธอด ฟิลด์ และตัวอย่าง จะให้พร้อมกับคีย์ เมื่อร้านหรือผู้พัฒนาของร้านขอมา
คำอธิบายเมธอดที่วางไว้บนเว็บไซต์ ช่วยคนที่ตามหาการเชื่อมต่อของคนอื่นมากกว่าช่วยผู้พัฒนา ผู้พัฒนาต้องการแค่ครั้งเดียวและได้รับภายในไม่กี่นาที ส่วนบอตค้นหาไม่มีเหตุให้ต้องได้ เขียนมาหาเรา แล้วจะได้คำอธิบายภายในวันเดียวกัน
การยืนยันตัวตน
เข้าใช้ด้วย คีย์เชื่อมต่อ คีย์เป็นของร้านเดียว: ข้อมูลของร้านอื่นเข้าถึงผ่านคีย์นี้ไม่ได้ เพราะโครงสร้างของระบบ ไม่ใช่เพราะ «มีการตรวจในโค้ด»
- ร้านออกคีย์ในหลังบ้าน และคีย์แสดงครั้งเดียว
- ส่วนลับเราเก็บเป็น แฮช — กู้คืนไม่ได้ ทำได้แค่ออกคีย์ใหม่
- เพิกถอนได้ทันที: คีย์ที่เพิกถอนแล้วใช้ไม่ได้ตั้งแต่คำขอถัดไป
- คีย์อยู่ บนเซิร์ฟเวอร์ของหน้าร้าน ไม่ควรอยู่ในเบราว์เซอร์ของลูกค้า ในแอปมือถือ หรือในรีโพซิทอรี
ถ้าคีย์หลุดไปในแชทกลุ่ม ในรีโพซิทอรีสาธารณะ หรือในโค้ดฝั่งลูกค้า — เพิกถอนแล้วออกคีย์ใหม่ กดปุ่มเดียว และถูกกว่าผลที่ตามมาทุกอย่าง
การเชื่อมต่อทำอะไรได้
| ความสามารถ | หน้าร้านได้อะไร |
|---|---|
| เมนู | หมวดหมู่ เมนู ราคา ตัวเลือกเพิ่มเติม รูปภาพ — ไม่รวมรายการที่หยุดขาย |
| รับออเดอร์ | ส่งออเดอร์ในคำขอเดียวและได้เลขออเดอร์ |
| แก้ไขและยกเลิก | ได้จนกว่าร้านจะรับออเดอร์ |
| ตรวจโค้ดส่วนลด | ส่วนลดบนหน้าร้านและบนแคชเชียร์คำนวณเหมือนกัน |
| แจ้งการชำระเงิน | การจ่ายฝั่งหน้าร้านเชื่อมกับวิธีชำระเงินของร้าน |
| สถานะการรับออเดอร์ | ร้านรับออเดอร์อยู่ตอนนี้หรือไม่ |
| ส่งสถานะกลับ | รับแล้ว กำลังทำ ส่งให้ไรเดอร์แล้ว — การแจ้งเตือนส่งไปที่หน้าร้านและลงนามด้วยรหัสลับร่วม |
ป้องกันการซ้ำ (idempotency)
หน้าร้านส่งทุกออเดอร์พร้อม คีย์ของการทำรายการ ของตัวเอง ส่งซ้ำด้วยคีย์เดิมจะไม่สร้างออเดอร์ที่สอง — ป้องกันการกดสองครั้ง สัญญาณหลุด และการส่งซ้ำของคิว
ผลในทางปฏิบัติ: ถ้าสัญญาณหลุด ส่งคำขอซ้ำได้ไม่ต้องกลัว ที่ต้องระวังคือกลับกัน — สร้างคีย์การทำรายการใหม่ให้ออเดอร์เดิมของลูกค้า
สิ่งที่ควรรู้ตอนพัฒนา
- รายการระบุด้วยรหัส ไม่ใช่ชื่อ: ชื่อเปลี่ยนได้ รหัสไม่เปลี่ยน
- ตัวเลือกเพิ่มเติมส่งแยก จากเมนู พร้อมรหัสและราคาของตัวเอง
- ราคาของแถวคือเงิน: เซิร์ฟเวอร์ตรวจสอบราคาและไม่เดาเอง
- รายการหมดเปลี่ยนตลอด: ขอเมนูก่อนแสดงทุกครั้ง ไม่แคชไว้ทั้งวัน
- ตัวเลือกบังคับที่ยังไม่ได้เลือก ไม่ทำให้ถูกปฏิเสธ — ออเดอร์จะเข้ามา และผู้ดูแลเลือกเอง
- มีการจำกัดความถี่ของคำขอ และมีด่านแยกสำหรับการตรวจโค้ดส่วนลดผิดซ้ำ ๆ หน้าร้านปกติไม่ติด ส่วนลูปสุ่มเดาจะติดทันที
ข้อผิดพลาด
คำตอบเมื่อเกิดข้อผิดพลาดอธิบายชัด: เห็นว่ารายการไหนไม่ผ่านและเพราะอะไร ตอนเชื่อมต่อ ให้บันทึกเนื้อหาคำตอบทั้งหมดลงล็อก — ประหยัดเวลาเขียนคุยกันได้หลายชั่วโมง
ข้อยกเว้นเดียวคือคีย์ผิด: จะได้คำตอบสั้น ๆ ไม่มีรายละเอียด ตั้งใจทำแบบนี้ เพื่อให้ดูจากรูปแบบข้อผิดพลาดไม่ได้ว่าคีย์ถูกหรือไม่
ตรวจสอบก่อนเปิดใช้
- ขอเมนูและแสดงบนหน้าร้าน รวมถึงรายการหมด
- ส่งออเดอร์ทดลองและเห็นออเดอร์ในแผงของแคชเชียร์
- ส่งซ้ำด้วยคีย์การทำรายการเดิม และตรวจว่าไม่มีออเดอร์ที่สอง
- ตรวจโค้ดส่วนลด — ทั้งที่ใช้ได้และที่หมดอายุ
- แจ้งการชำระเงิน และเห็นว่าออเดอร์ปิดด้วยวิธีชำระเงินที่ถูกต้อง
- ตรวจกรณีสัญญาณหลุด: หยุดคำตอบกลางทางแล้วส่งคำขอซ้ำ