คีย์ API
สร้างคีย์ที่เชื่อมต่อเว็บไซต์หรือซอฟต์แวร์ของคุณกับ Measure Map Online เลือกสิ่งที่คีย์ทำได้ แยกงานจริงออกจากงานทดสอบ และเปลี่ยนหรือจำกัดคีย์อย่างปลอดภัย
คีย์ API ช่วยให้เว็บไซต์หรือซอฟต์แวร์ของคุณทำงานกับบัญชี Measure Map Online ของคุณได้: แสดงแผนที่ของโปรเจกต์บนเว็บไซต์ของคุณ เริ่มโปรเจกต์ให้ผู้เข้าชม ของคุณ หรืออ่านและเปลี่ยนโปรเจกต์ผ่าน REST API คุณสร้างและจัดการคีย์ในหน้า นักพัฒนา
เปิดหน้านักพัฒนา#
ในเมนูแดชบอร์ด ใต้ ขั้นสูง กด นักพัฒนา จะเปิดที่ คีย์ API และส่วนอื่น ๆ แสดงอยู่ใต้ส่วนนี้ในเมนู (บนโทรศัพท์จะเป็นแท็บที่ด้านบนของหน้า):
- ลิงก์ผู้เยี่ยมชม (Open Guest): ลิงก์แบบไม่ต้อง เขียนโค้ดสำหรับเว็บไซต์ของคุณ ดู Open Guest
- ลองใช้ API, Webhooks และ REST API: ดูเอกสารอ้างอิง API
- ฝังแผนที่ (Enterprise): ดู iFrame API
- โปรเจกต์ส่วนตัว (Enterprise): แสดง โปรเจกต์ส่วนตัวของลูกค้าในแผนที่ฝังของคุณ ดู โปรเจกต์ส่วนตัวของลูกค้า
ป้ายที่ด้านบนของการ์ดคีย์บอกว่าคีย์ของคุณ ใช้งานอยู่, ยังไม่เปิดใช้งาน (ยังไม่มีคีย์), ปิดใช้งาน (ระงับการเข้าถึง API: ไม่มีคีย์ใดใช้ได้และสร้างคีย์ใหม่ไม่ได้ จนกว่าฝ่ายสนับสนุนจะยกเลิกการระงับ) หรือ หมดอายุแล้ว (การสมัครสมาชิก ไม่ได้ใช้งานอยู่)
Live และ Sandbox#
ที่ด้านบนของการ์ดคีย์ สลับระหว่าง ใช้งานจริง และ Sandbox แต่ละแบบมีคีย์ของตนเอง และหน้าจะแสดง คีย์ที่คุณเลือก ตัวเลือกนี้ใช้ใน ลองใช้ API ด้วย และคงอยู่ขณะที่คุณ สลับระหว่างส่วนต่าง ๆ ฝังแผนที่ และ ลิงก์ผู้เยี่ยมชม ใช้คีย์จริงของคุณเสมอ เพราะผู้เข้าชมเว็บไซต์ของคุณเปิดได้ เฉพาะโปรเจกต์จริง: การเปิดส่วนใดส่วนหนึ่งจะสลับหน้ากลับไปที่ ใช้งานจริง
- ใช้งานจริง คือบัญชีจริงของคุณ และหน้าจะเปิดที่แบบนี้ ใช้คีย์จริงบน เว็บไซต์ของคุณ
- Sandbox ใช้สำหรับสร้างและทดสอบการเชื่อมต่อ โปรเจกต์ โฟลเดอร์ และสินค้าที่สร้างด้วยคีย์ sandbox จะแยกจากของจริงของคุณ: คีย์จริงมองไม่เห็น และคีย์ sandbox ก็มองไม่เห็นของจริง คำขอที่ใช้คีย์ sandbox จะไม่นับรวมใน ตัวเลขการใช้งานของคุณ และโปรเจกต์ผู้เยี่ยมชมที่สร้างด้วยคีย์นั้นจะไม่ถูก เรียกเก็บเงิน
การสร้างคีย์ sandbox ใหม่ไม่กระทบคีย์จริงของคุณ และในทางกลับกันก็เช่นกัน
เลือกสิ่งที่คีย์ทำได้#
เมื่อคุณสร้างคีย์ กล่องโต้ตอบจะแสดงแต่ละส่วนของ API ใต้ สิทธิ์เข้าถึงของคีย์ใหม่ เลือกว่าคีย์ใหม่เข้าถึงแต่ละส่วนได้เพียงใด:
| ส่วน | ตัวเลือก | สิ่งที่อนุญาต |
|---|---|---|
| แผนที่ที่ฝัง (Enterprise) | ไม่มีสิทธิ์เข้าถึง, อนุญาต | ให้ผู้ชมเข้าสู่ระบบในแผนที่ที่ฝัง การผสานรวมส่วนใหญ่ต้องการเพียงอย่างนี้ |
| โปรเจกต์ผู้เยี่ยมชม (Open Guest) | ไม่มีสิทธิ์เข้าถึง, อนุญาต | เริ่มโปรเจกต์ผู้เยี่ยมชมให้ผู้เยี่ยมชม ด้วยโทเค็นจากเซิร์ฟเวอร์ของคุณ การผสานรวมส่วนใหญ่ต้องการเพียงอย่างนี้ |
| โปรเจกต์ | ไม่มีสิทธิ์เข้าถึง, อ่าน, อ่านและเปลี่ยนแปลง | โปรเจกต์และโฟลเดอร์ พร้อมการวัด ความคิดเห็น และการส่งออก |
| ผู้ใช้ (Enterprise) | ไม่มีสิทธิ์เข้าถึง, อ่าน, อ่านและเปลี่ยนแปลง | ผู้ใช้ในองค์กรของคุณ คำเชิญ ที่นั่ง และทีมของพวกเขา |
| องค์กร (Enterprise) | ไม่มีสิทธิ์เข้าถึง, อ่าน, อ่านและเปลี่ยนแปลง | โปรไฟล์ นโยบาย การลงชื่อเข้าใช้ครั้งเดียว และบันทึกกิจกรรมขององค์กรของคุณ รวมถึงที่นั่ง |
| สินค้า | ไม่มีสิทธิ์เข้าถึง, อ่าน, อ่านและเปลี่ยนแปลง | แคตตาล็อกสินค้าและราคาของคุณ |
| ผู้เยี่ยมชม (Open Guest) | ไม่มีสิทธิ์เข้าถึง, อ่าน, อ่านและเปลี่ยนแปลง | ลิงก์ผู้เยี่ยมชม โปรเจกต์ผู้เยี่ยมชม และคำขอใบเสนอราคาของคุณ พร้อมรายละเอียดติดต่อของผู้เยี่ยมชม และงบประมาณของคุณ |
| บัญชี | ไม่มีสิทธิ์เข้าถึง, อ่าน, อ่านและเปลี่ยนแปลง | แผน ที่นั่ง การใช้ API โปรไฟล์และการตั้งค่าอีเมลของคุณ และสำหรับ Open Guest คือค่าใช้จ่ายและงบประมาณของคุณ |
| นักพัฒนา | ไม่มีสิทธิ์เข้าถึง, อ่าน, อ่านและเปลี่ยนแปลง | คีย์ API และ webhook ของคุณ คีย์ไม่เกินสิทธิ์ของตัวเองเลย |
| ลูกค้า (พาร์ทเนอร์) | ไม่มีสิทธิ์เข้าถึง, อ่าน, อ่านและเปลี่ยนแปลง | ลูกค้าของคุณ แผนที่คุณจ่ายให้พวกเขา คำเชิญและใบแจ้งหนี้ของพวกเขา |
กล่องโต้ตอบแสดงเฉพาะส่วนที่แผนของคุณรวมอยู่ วางตัวชี้เหนือตัวเลือกเพื่อดูว่า ให้สิทธิ์อะไรบ้างอย่างแม่นยำ คีย์แรกของคุณเริ่มต้นด้วย แผนที่ที่ฝัง อย่างเดียว ซึ่งเป็นสิ่งเดียวที่แผนที่ฝังต้องการ ส่วนคีย์ ที่มาแทนคีย์อื่นจะเริ่มด้วยสิทธิ์ของคีย์นั้น เลือกอย่างน้อยหนึ่งส่วน
สิ่งที่คีย์ทำได้ถูกกำหนดตายตัวเมื่อคุณสร้าง หากต้องการให้คีย์เข้าถึงมากขึ้นหรือ น้อยลง ให้สร้างคีย์ใหม่
สร้างคีย์#
- เลือก ใช้งานจริง หรือ Sandbox ที่ด้านบนของการ์ดคีย์
- กด สร้างคีย์ใหม่ กล่องโต้ตอบจะเปิดขึ้น พร้อม ใช้งานจริง หรือ Sandbox ข้างชื่อ
- ตั้งสิทธิ์ใต้ สิทธิ์เข้าถึงของคีย์ใหม่ (ดูด้านบน)
- หากต้องการ พิมพ์ชื่อใน ชื่อสำหรับคีย์ใหม่ (ไม่บังคับ) เพื่อแยกแยะคีย์ของคุณ
- กด สร้าง
จากนั้นกล่องโต้ตอบจะแสดง คีย์ใหม่ของคุณพร้อมแล้ว คุณคัดลอกซ้ำจากหน้านี้ได้ทุกเมื่อ พร้อมคีย์ซึ่งซ่อนไว้ยกเว้น อักขระตัวแรกและตัวสุดท้าย และสิ่งที่คีย์ ทำได้ กด เพื่อแสดงคีย์ทั้งหมด หรือ เพื่อคัดลอก คีย์ทั้งหมด แล้วกด เสร็จสิ้น การ์ดคีย์แสดงคีย์ในลักษณะเดียวกันใต้ คีย์ API ของคุณ คุณจะได้รับอีเมลทุกครั้งที่มีการสร้างคีย์ในบัญชีของคุณ
คีย์ที่สร้างก่อนมีการตั้งค่าสิทธิ์#
คีย์ที่สร้างก่อนที่คีย์จะมีการตั้งค่าสิทธิ์ทำได้ทุกอย่าง ยกเว้นการทำงานกับสินค้า คีย์เช่นนี้กำลังจะเลิกใช้: การ์ดคีย์จะบอกว่า คีย์ของคุณหยุดทำงานเมื่อใด และคุณจะได้รับการแจ้งเตือนด้วย กด สร้างคีย์ใหม่ ซึ่งการ์ดจะแสดงเป็นปุ่มหลักในตอนนั้น และเปลี่ยน คีย์เก่าบนเว็บไซต์หรือเซิร์ฟเวอร์ของคุณก่อนถึงวันที่นั้น กล่องโต้ตอบเริ่มด้วย แผนที่ที่ฝัง อย่างเดียว ดังนั้นให้เลือกเพิ่มหากเซิร์ฟเวอร์ของคุณต้องการ
เปลี่ยนคีย์#
กด สร้างคีย์ใหม่ อีกครั้งเมื่อคุณมีคีย์อยู่แล้ว และสร้าง คีย์ใหม่ในกล่องโต้ตอบ กล่องโต้ตอบบอกว่าคีย์ปัจจุบันจะเป็นอย่างไร: จะสร้างคีย์ใหม่และคีย์ปัจจุบันของคุณจะใช้ได้ต่ออีก 24 ชั่วโมง เพื่อให้คุณอัปเดตเว็บไซต์ที่ใช้คีย์นั้น คุณเพิกถอนได้เร็วกว่านั้นเมื่อเสร็จแล้ว คีย์ที่สร้างก่อนมีการตั้งค่าสิทธิ์จะใช้ต่อได้ จนถึงวันที่ที่แจ้งให้คุณทราบแทน
คีย์เก่าจะย้ายไปที่ คีย์ก่อนหน้า พร้อมเวลาที่เหลือ เวลาที่ใช้ล่าสุด และสิ่งที่คีย์ทำได้ ยังรับอยู่ขณะที่คุณเปลี่ยนไปใช้คีย์ใหม่ เพิกถอนคีย์ทันทีที่ไม่มีอะไรใช้งานอยู่ หากต้องการหยุดทันที กด เพิกถอน และยืนยัน เว็บไซต์ใดที่ยังใช้คีย์นั้นจะหยุด ทำงานทันที คุณจะได้รับอีเมลเมื่อมีการเพิกถอนคีย์
การจำกัดเว็บไซต์ของคุณจะถูกคัดลอกไปยังคีย์ใหม่ คุณสร้างคีย์ใหม่ได้ประมาณ นาทีละครั้ง
จำกัดคีย์ให้ใช้กับเว็บไซต์ของคุณ#
เฉพาะเว็บไซต์ในรายการนี้เท่านั้นที่ใช้คีย์ของคุณในเบราว์เซอร์ได้: แผนที่ฝังและคำขอจากหน้าเว็บบนไซต์อื่นจะถูกปฏิเสธ การเรียกจากเซิร์ฟเวอร์ไม่ได้รับผลกระทบ
- ใต้ ข้อจำกัดเว็บไซต์ พิมพ์เว็บไซต์ของคุณใน
ป้อนเว็บไซต์หรือโดเมน: โดเมน เช่น
example.comที่อยู่ IP หรือlocalhostคุณวางที่อยู่เต็มได้ โดยระบบจะเก็บเฉพาะชื่อ เว็บไซต์ ไม่รวมhttps://พาธ หรือพอร์ต - กด เพิ่ม
โดเมนครอบคลุมโดเมนย่อยด้วย: example.com อนุญาต
shop.example.com กด เพื่อลบเว็บไซต์ และยืนยัน
หลังจากลบอันสุดท้าย คีย์จะใช้ได้จากเว็บไซต์ใดก็ได้ คุณจะได้รับอีเมลทุกครั้งที่
ลบเว็บไซต์ออกจากคีย์
รายการนี้ใช้กับเบราว์เซอร์ แผนที่ฝังจะเปิดได้เฉพาะบนหน้าของเว็บไซต์ที่อยู่ใน รายการ หากเบราว์เซอร์ไม่บอกว่าอยู่ในหน้าใด จะถูกปฏิเสธ คำขอ REST API ที่ส่ง จากหน้าเว็บต้องมาจากเว็บไซต์ในรายการ คำขอจากเซิร์ฟเวอร์ของคุณเองไม่ระบุ เว็บไซต์และจะไม่ถูกตรวจสอบ ส่วน Measure Map Online เองได้รับอนุญาตเสมอ ตัวอย่างในหน้านี้จึงใช้งานได้ต่อไป
ดูว่าคีย์ถูกใช้อย่างไร#
การใช้งาน รวมคีย์จริงทั้งหมดของคุณ ตัวเลขจึงต่อเนื่องเมื่อคุณเปลี่ยนคีย์ แสดงคำขอใน 30 วันที่ผ่านมา ทั้งจากแผนที่ฝังและ REST API พร้อมแถบสำหรับแต่ละวัน ยอดรวม ตลอดเวลา เข้าถึงล่าสุด เวลาที่สร้างคีย์ปัจจุบัน (สร้างคีย์แล้ว) และ โดเมนยอดนิยม: เว็บไซต์ที่ใช้คีย์ของ คุณมากที่สุด เว็บไซต์ที่คุณไม่รู้จักในรายการนี้เป็นเหตุผลให้จำกัดหรือเปลี่ยนคีย์
คำขอ sandbox ไม่นับ ตัวเลขจึงแสดงที่ ใช้งานจริง เท่านั้น และคำขอที่หน้านี้ ส่งเองใน ลองใช้ API และตัวอย่างก็ไม่นับเช่นกัน
รักษาคีย์ของคุณให้ปลอดภัย#
- ให้แต่ละคีย์มีเฉพาะสิทธิ์ที่จำเป็น คีย์ในหน้าเว็บ (เช่นในที่อยู่ของแผนที่ฝัง) ควรมี แผนที่ที่ฝัง อย่างเดียว
- คีย์นี้เปลี่ยนแปลงข้อมูลของคุณได้ เก็บไว้บนเซิร์ฟเวอร์ของคุณ อย่าใส่ในหน้าเว็บหรือแอป
- จำกัดคีย์ที่ใช้ในหน้าเว็บให้ใช้ได้กับเว็บไซต์ของคุณเองเท่านั้น
- ปล่อยให้คีย์ซ่อนอยู่บนหน้าเมื่อคุณแชร์หน้าจอ การคัดลอกคีย์ไม่ต้องแสดงคีย์เลย
- หากคีย์อาจรั่วไหล ให้สร้างคีย์ใหม่และเพิกถอนคีย์เก่าใต้ คีย์ก่อนหน้า ทันที
- สร้างและทดสอบด้วยคีย์ Sandbox เพื่อให้การทดลองไม่ไปปะปนกับ โปรเจกต์จริงของคุณ
ยังต้องการความช่วยเหลือ?
เขียนถึงทีมสนับสนุนของเราและบอกว่าคุณพยายามทำอะไรอยู่ ภาพหน้าจอช่วยได้มาก