Developer integration

7stamp REST API

Available

7stamp Integration API ช่วยให้ CRM, แพลตฟอร์มอีคอมเมิร์ซ, POS, แบ็กเอนด์ที่กำหนดเอง หรือเครื่องมืออัตโนมัติจัดการ Wallet Loyalty Card ด้วยตัวระบุผู้ติดต่อที่ระบบของคุณใช้อยู่แล้ว เป็นตัวเลือกที่เป็นสากลเมื่อไม่มีการบูรณาการแบบพิเศษ

API ฐาน URL คือ https://api.7loc.com/cards-api. พิสูจน์ตัวตนทุกคำร้องขอด้วยคีย์ API เป็นโทเค็น Bearer ใช้การอ้างอิง OpenAPI ที่เชื่อมโยงสำหรับคำขอแบบสดและสกีมาการตอบกลับก่อนที่จะสร้างตรรกะที่ใช้งานจริง

เปิด API อ้างอิง เปิด OpenAPI JSON

สิ่งที่คุณสามารถทำได้กับ API

API คือด้านการเขียนของ integrated stack ใช้เมื่อใดก็ตามที่ซอฟต์แวร์ของคุณควรคงแหล่งที่มาของการดำเนินงานที่แท้จริง ในขณะที่ 7stamp จัดการเลเยอร์ความภักดีของกระเป๋าเงิน

ออกบัตรจากซอฟต์แวร์ของคุณเอง

สร้างลิงก์บัตรกระเป๋าเงินส่วนตัวสำหรับลูกค้าใดๆ ในระบบของคุณ ส่งผ่านอีเมลของคุณเอง SMS พุช หรือโฟลว์ในแอป ลูกค้าเปิดลิงก์และบันทึกการ์ดลงใน Apple Wallet หรือ Google Wallet

เครดิตแสตมป์จากแหล่งใดๆ

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

จัดการบัตรกำนัลและแคมเปญ

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

Documented Integration การดำเนินการ API

เหล่านี้เป็นเส้นทาง API สาธารณะที่อยู่เบื้องหลังการดำเนินการ Make และ Zapier อ่านสกีมาที่แน่นอนในการอ้างอิง API อย่าอนุมานชื่อฟิลด์จากจุดสิ้นสุดอื่น

การ์ด POST /cards/invite

สร้างการ์ดเชิญ

สร้างการติดตั้งส่วนตัวใหม่สำหรับ URL สำหรับผู้ติดต่อภายนอก

Cards POST /cards/invite/bulk

สร้างการ์ดเชิญเป็นกลุ่ม การ์ด

สร้างลิงก์เชิญได้มากถึง 100 ลิงก์ในชุดควบคุม

การ์ด GET /cards

ค้นหาการ์ด

ค้นหาบันทึกการ์ดตามตัวระบุผู้ติดต่อภายนอก

Cards GET /cards/{user_card_id}

รับรายละเอียดการ์ด การ์ด

ส่งคืนสถานะเต็มของการ์ดหนึ่งใบโดย 7stamp ID ภายใน

การ์ด POST /cards/scan

สแกนการ์ด

เพิ่มแสตมป์ด้วยการ์ด ID หรือ External ID และบันทึกลำดับแหล่งที่มาเมื่อระบุ

Templates GET /templates

รายการเทมเพลต

แสดงรายการเทมเพลตการ์ดที่พร้อมใช้งานในสถานที่ทำงานของคีย์/profile.

Templates GET /templates/{template_id}/design

รับการออกแบบเทมเพลต

อ่านการตั้งค่าภาพสำหรับเทมเพลตการ์ดที่รู้จัก

Vouchers POST /vouchers/issue

ออกบัตรกำนัล

ออกบัตรกำนัลให้กับเจ้าของบัตร

Messages POST /messages/send

ส่งข้อความ

ส่ง wallet-card push และเนื้อหาอีเมล /or ไปยังเจ้าของการ์ด

ตำแหน่งที่จะสร้างและคัดลอกคีย์ API

นี่คือหน้าจอ 7stamp Admin จริง เปิด API & Integrations เพิ่มคีย์ จากนั้นคัดลอกลงในความลับฝั่งเซิร์ฟเวอร์ที่ปลอดภัยหรือการเชื่อมต่ออัตโนมัติ หน้าจอ

7stamp Admin API & Integrations แสดงปุ่ม Add API Key และไดอะล็อกสร้างคีย์ API
ขั้นตอนที่ 1 — เลือก API & Integrations ในการนำทางด้านซ้าย เปิด API Keys เลือก Add API Key เลือกล็อกอินของพนักงานที่เหมาะสม และสร้างคีย์ ไดอะล็อก
7stamp Admin แสดงคีย์ API ที่สร้างขึ้นใหม่และการควบคุมการคัดลอก
ขั้นตอนที่ 2 — คัดลอกคีย์ใหม่ไปยังตัวจัดการรหัสผ่าน ข้อมูลลับฝั่งเซิร์ฟเวอร์ หรือการเชื่อมต่อ Make/Zapier ที่ปลอดภัย อย่าวางลงในซอร์สโค้ด แอปพลิเคชันเบราว์เซอร์ หรือตั๋วสนับสนุน

การตัดสินใจสามครั้งก่อนที่จะเข้ารหัสขอบเขตคีย์

API

สร้างคีย์ใน 7stamp Admin ภายใต้ API Integrations → API Keys → Add API Key คีย์เป็นของที่ทำงานแห่งเดียว/profile ดังนั้นให้สร้างคีย์แยกต่างหากสำหรับการพัฒนาและการใช้งานจริงเมื่อการตั้งค่าบัญชีของคุณอนุญาต หมุนเวียนหรือเพิกถอนการเข้าถึงจากแดชบอร์ดหากมีการเปิดเผยข้อมูลลับ

Customer Identity

External ID คือตัวระบุผู้ติดต่อที่เสถียรจากระบบของคุณ: CRM ID, ลูกค้า UUID, หมายเลขโทรศัพท์ หรืออีเมล ต้องการระบบ ID ที่ไม่เปลี่ยนรูป ทางเลือกเพิ่ม External Source เพื่อหลีกเลี่ยงการชนกันระหว่างระบบ และเพื่อทำให้ความสัมพันธ์ของเว็บฮุคชัดเจน

การเลือกเทมเพลต

เมื่อโปรไฟล์มีหนึ่งเทมเพลตที่แอ็คทีฟ สามารถละเว้น template_id และ 7stamp จะเลือกโดยอัตโนมัติ เมื่อมีหลายเทมเพลตที่แอ็คทีฟ ให้ส่ง template_id ที่ต้องการ อ่าน GET /templates ก่อน แทนที่จะเขียนโค้ด ID ที่คาดเดายาก

คำขอตรวจสอบสิทธิ์ขั้นต่ำ: สร้างคำเชิญ

คัดลอกสิ่งนี้ลงในขั้นตอนการทำงานอัตโนมัติของคุณ bash 
curl -X POST "https://api.7loc.com/cards-api/cards/invite" \
  -H "Authorization: Bearer YOUR_7STAMP_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "external_id": "crm_contact_8821",
    "external_source": "hubspot",
    "template_id": 42
  }'

จากคีย์ API ไปจนถึงคำขอแรกที่สำเร็จ

01

ลงชื่อเข้าใช้ 7stamp Admin และสร้างคีย์: API Integrations → API Keys → Add API Key เก็บไว้ในเครื่องมือจัดการความลับของคุณ ไม่ใช่ซอร์สโค้ดหรือแอปพลิเคชันฝั่งไคลเอ็นต์

02

ตั้งค่าฐาน URL เป็น https://api.7loc.com/cards-api และเพิ่ม Authorization: Bearer ตามด้วยคีย์ไปยังทุกคำร้องขอฝั่งเซิร์ฟเวอร์

03

เรียก GET /templates ก่อน การตอบกลับที่สำเร็จจะยืนยันโทเค็นและแสดงเทมเพลตที่พร้อมใช้งานสำหรับที่ทำงานนั้น/profile.

04

เลือก External ID ที่เสถียรและ External Source ทางเลือกจากระบบของคุณเอง ใช้คู่ข้อมูลระบุตัวตนที่เหมือนกันทุกประการในการสร้าง สแกน ค้นหา และตรรกะของเว็บฮุค

05

เรียก POST /cards/invite พร้อมด้วยหน้าสัมผัสทดสอบแบบใช้แล้วทิ้ง ตรวจสอบการติดตั้ง URL ที่ส่งคืน ก่อนที่จะส่งมอบให้กับลูกค้าจริงโดยอัตโนมัติ

06

เพิ่มการดำเนินการ POST /cards/scan บัตรกำนัล หรือข้อความหลังจากที่คุณมีการบันทึก การจัดการข้อผิดพลาด และลองกลยุทธ์ /idempotency ใหม่อย่างปลอดภัยในแบ็กเอนด์ของคุณเอง

ใช้การอ้างอิง API เป็นสัญญา

การอ้างอิง Swagger/OpenAPI แบบพับลิกประกอบด้วยจุดสิ้นสุด พารามิเตอร์ เนื้อหาคำขอ การตอบกลับ และสกีมา webhook ปัจจุบัน URL แบบโต้ตอบคือ https://api.7loc.com/cards-api/docs และสัญญาที่เครื่องอ่านได้คือ https://api.7loc.com/cards-api/openapi.json. อ่านก่อนดำเนินการจัดการข้อผิดพลาดหรือเพิ่มฟิลด์ทางเลือก

การพิสูจน์ตัวตนและความปลอดภัยของคีย์

คีย์เป็นความลับฝั่งเซิร์ฟเวอร์ อย่าเปิดเผยข้อมูลดังกล่าวในเบราว์เซอร์ JavaScript, ชุดแอปบนอุปกรณ์เคลื่อนที่, แบบฟอร์มสาธารณะ, ภาพหน้าจอ, ช่องข้อความ Make/Zapier หรือตั๋วสนับสนุน ใช้เซิร์ฟเวอร์ การเชื่อมต่ออัตโนมัติที่ปลอดภัย หรือเครื่องมือจัดการความลับ หากคีย์ถูกแชร์โดยไม่ได้ตั้งใจ ให้เพิกถอนหรือหมุนคีย์ใน 7stamp Admin และอัพเดตการเชื่อมต่อที่ได้รับผลกระทบ

คำถามที่พบบ่อย

ฉันจะรับโทเค็น 7stamp API ได้ที่ไหน

ใน 7stamp Admin ไปที่ API Integrations → API Keys → Add API Key จากนั้นโทเค็นจะถูกส่งในส่วนหัว Authorization เป็น Bearer ตามด้วยคีย์

URL พื้นฐานและวิธีการพิสูจน์ตัวตนคืออะไร?

ใช้ https://api.7loc.com/cards-api และส่ง Authorization: Bearer YOUR_7STAMP_API_KEY ในแต่ละคำร้องขอที่ได้รับอนุญาต

ฉันจะละเว้น template_id ได้เมื่อใด

เฉพาะเมื่อโปรไฟล์ที่เชื่อมต่อมีเทมเพลตการ์ดที่ใช้งานอยู่เพียงเทมเพลตเดียวเท่านั้น หากมีหลายเทมเพลตแอ็คทีฟ ให้เลือก template_id ที่ถูกต้องจาก GET /templates.

ฉันควรใช้ API, Make หรือ Zapier หรือไม่

ใช้ API สำหรับ POS แบบกำหนดเอง แบ็กเอนด์ ไซต์ หรือการควบคุมทั้งหมด ใช้ Make สำหรับสถานการณ์จำลองการแยกส่วนด้วยภาพ ใช้ Zapier สำหรับเวิร์กโฟลว์การดำเนินการทริกเกอร์เชิงเส้นเป็นส่วนใหญ่ ทั้งสามใช้คีย์ API และสัญญา API เดียวกัน

หน้าที่เกี่ยวข้อง

เปิด API อ้างอิง เปิด OpenAPI JSON Webhook guide Make HTTP guide

ขั้นตอนถัดไป

ทดสอบโฟลว์ API ที่ปลอดภัยที่สุดก่อน

สร้างคีย์ เรียก GET /templates สร้างคำเชิญหนึ่งรายการสำหรับผู้ติดต่อแบบใช้แล้วทิ้ง จากนั้นเพิ่มความลับในการผลิต การบันทึก การลองใหม่ และการจัดการเว็บฮุคตามคำขอที่พิสูจน์แล้ว

เปิดการอ้างอิง API เปิด 7stamp Admin