วิธีใช้ Store App Content API (ประกาศ / เพจ / ข้อมูลการเปิดทำการ)

วัตถุประสงค์ของคู่มือนี้

รวบรวมวิธีใช้ /api/v1/apps/{shopId}/* สำหรับดึงคอนเทนต์ที่สโตร์แอป (Web เรนเดอเรอร์・LINE มินิแอป・แอป iOS / Android) แสดง — ประกาศ・เพจ・มานิเฟสต์ของแอป・ข้อมูลการเปิดทำการ・การตั้งค่าบัตรสมาชิก

รายการเอนด์พอยต์

ตัวอย่าง: ดึงประกาศ

ส่ง ID ของบัญชีธุรกิจใน {shopId}

GET /api/v1/apps/{organizationId}/posts?status=Published&take=20

ประกาศ・เพจ・มานิเฟสต์เป็นระดับบัญชีธุรกิจ ไม่ว่าจะเลือกร้านค้าใดภายใต้บัญชีธุรกิจเดียวกันก็จะได้เนื้อหาเดียวกัน (ไม่ได้แยกตามร้านค้า)

ตัวอย่าง: ดึงข้อมูลการเปิดทำการ (ระดับร้านค้า)

เนื่องจากเวลาทำการต่างกันในแต่ละร้านค้า จึงต้องส่ง storeId เป็นเควรีที่จำเป็น

GET /api/v1/apps/{organizationId}/business-info?storeId={storeId}&specialDaysAhead=30

storeId คือ ID ของร้านค้าที่ GET /api/v1/me/organizations/{organizationId}/stores คืนมา

เกี่ยวกับการแมป store → shopId

แอปทำงานตามลำดับ "เลือกบัญชีธุรกิจ → เลือกร้านค้า" จึงถือค่าทั้ง organizationId และ storeId ไว้อยู่แล้ว ให้ส่งไปยัง Content API ดังนี้

• ประกาศ・เพจ・มานิเฟสต์・การตั้งค่าบัตรสมาชิก → ส่ง organizationId ใน {shopId} (ไม่ต้องระบุร้านค้า)
• ข้อมูลการเปิดทำการ → ส่ง organizationId ใน {shopId} และส่ง ID ร้านค้าในเควรี storeId

การยืนยันตัวตน

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

เกี่ยวกับการสร้างประกาศ

ในปัจจุบัน posts เป็นอ่านได้อย่างเดียว (ไม่มีเอนด์พอยต์สร้าง・อัปเดตผ่าน API) การแก้ไขประกาศทำจากหน้าจอจัดการของ ReceiptRoller ในอนาคต หากต้องการให้พนักงานร้านค้าโพสต์ประกาศจากแอปได้ จะเพิ่มเอนด์พอยต์สำหรับเขียนและขอบเขตเฉพาะแยกต่างหาก

คู่มือที่เกี่ยวข้อง

• การดึงรายการบัญชีธุรกิจ・ร้านค้า・เครื่อง POS — แหล่งที่มาของ organizationId / storeId
• วิธีใช้ Business Hours API
• กลับไปยังหน้าช่วยเหลือสำหรับนักพัฒนา