คู่มือเริ่มต้นด่วนนี้ให้ข้อมูลพื้นฐานเกี่ยวกับการตรวจสอบสิทธิ์ด้วยคีย์ API ที่จำเป็นสำหรับการเข้าถึง ทรัพยากร Cloudbeds API คู่มือนี้จะช่วยให้คุณได้รับคีย์ API อย่างรวดเร็วเพื่อเริ่มใช้งานกับการตรวจสอบสิทธิ์ของคุณ
หากคุณเป็นพันธมิตรทางเทคโนโลยี คุณสามารถสร้างคีย์ API ในระดับที่พักเพื่อเริ่มพัฒนาของคุณได้อย่างรวดเร็ว อย่างไรก็ตาม คุณจะต้องดำเนินการสนับสนุนคีย์ API ในระดับพันธมิตรตาม คู่มือการตรวจสอบสิทธิ์คีย์ API สำหรับพันธมิตรทางเทคโนโลยี ก่อนกระบวนการรับรอง
สำหรับวิธีการตรวจสอบสิทธิ์ OAuth 2.0 โปรดดูที่ วิธีการตรวจสอบสิทธิ์ OAuth 2.0 ทางเลือก
Cloudbeds เชื่อว่าธุรกิจที่พักแต่ละแห่งมีความเป็นเอกลักษณ์เฉพาะตัว เรามีเครื่องมือสำหรับที่พักขนาดต่างๆ และงบประมาณที่หลากหลาย เพื่อช่วยให้คุณสร้างและขยายธุรกิจ ติดต่อ ทีมงานเฉพาะทางของเรา เพื่อขอข้อมูลเพิ่มเติมเกี่ยวกับแพ็กเกจที่มีให้เลือก
ยังไม่ใช่ลูกค้า Cloudbeds ใช่ไหม? ตรวจสอบ คู่มือการกำหนดราคา และกำหนดเวลาการสาธิต
ก่อนสร้างข้อมูลรับรอง API
ก่อนสร้างข้อมูลรับรอง API ให้เปิดหน้าข้อมูล ข้อมูลรับรอง API ใน Cloudbeds สิ่งที่คุณเห็นบนหน้านี้ขึ้นอยู่กับว่าการเข้าถึง API รวมอยู่ในแพ็กเกจ Cloudbeds ของคุณแล้วหรือไม่
หากการเข้าถึง API ไม่รวมอยู่ในแพ็กเกจของคุณ: คุณจะเห็นปุ่ม ส่งแบบฟอร์มการเข้าถึง API แทนตัวเลือกในการสร้างข้อมูลรับรอง ส่งแบบฟอร์มเพื่อขอการเข้าถึง API และใบเสนอราคาจากทีม Customer Growth
ตัวอย่างด้านล่างแสดงหน้าข้อมูล ข้อมูลรับรอง API เมื่อยังต้องขอการเข้าถึง API
เมื่อเปิดใช้งานการเข้าถึง API สำหรับบัญชีของคุณแล้ว ให้กลับไปที่หน้าข้อมูล ข้อมูลรับรอง API และดำเนินการตามขั้นตอนด้านล่างต่อไป
1. การสร้างข้อมูลรับรอง API
เล่นวิดีโอนี้เพื่อเข้าใจกระบวนการสร้างคีย์ API
เมื่อเปิดใช้งานการเข้าถึง API แล้ว ให้สร้างการเชื่อมต่อก่อน จากนั้นสร้างคีย์ API เลือกสิทธิ์และที่พักที่ต้องการ และอนุญาตการเชื่อมต่อ
-
เข้าสู่ระบบบัญชี Cloudbeds ของคุณที่ https://signin.cloudbeds.com/ แล้วไปที่:
บัญชี
-> แอปและ Marketplace
- เปิดแท็บ ข้อมูลรับรอง API.
-
คลิก + ข้อมูลประจำตัวใหม่.
หน้าข้อมูลประจำตัว API จะแสดงการเชื่อมต่อที่มีอยู่ของคุณและปุ่ม + ข้อมูลประจำตัวใหม่ ที่ใช้เริ่มต้นการเชื่อมต่อใหม่
คุณยังสามารถแก้ไขข้อมูลรับรองของไคลเอนต์ที่สร้างไว้ก่อนหน้านี้ได้หากต้องการแปลงรายการนั้น ในกรณีนี้ ให้ข้ามไปที่ขั้นตอนที่ 6
-
กรอกรายละเอียดการเชื่อมต่อ API ใหม่:
- กรอก ชื่อ ของการเชื่อมต่อหรือแอปพลิเคชันของคุณ
- เลือก ประเภทการเชื่อมต่อ ที่ตรงกับแอปพลิเคชันของคุณมากที่สุด
- เนื่องจากการใช้คีย์ API ไม่จำเป็นต้องมี Redirect URL ที่ทำงานได้ คุณสามารถกรอก https://localhost ในช่อง Redirect URI
- เปิดใช้งาน เปิดใช้งานสำหรับทั้งองค์กร หากคุณต้องการให้การเชื่อมต่อนี้ใช้ได้กับหลายที่พักในองค์กร
- คลิก บันทึก ที่มุมล่างขวา
แบบฟอร์มการเชื่อมต่อ API ใหม่ประกอบด้วยชื่อการเชื่อมต่อ ประเภท Redirect URI และการตั้งค่าสำหรับทั้งองค์กร
-
Cloudbeds จะสร้างข้อมูลรับรองของไคลเอนต์ที่ประกอบด้วย รหัสไคลเอนต์ และ รหัสลับของไคลเอนต์ คุณสมบัติเหล่านี้ไม่จำเป็นต้องใช้ในเพย์โหลดของคำขอที่เปิดใช้งานด้วยคีย์ API ดังนั้นคุณสามารถปิดกล่องโต้ตอบและดำเนินการสร้างคีย์ API ต่อได้
กล่องโต้ตอบยืนยันยังเตือนคุณด้วยว่ารหัสลับของไคลเอนต์ไม่สามารถดูได้อีกหลังจากปิดกล่องโต้ตอบนี้
-
ค้นหาการเชื่อมต่อในตาราง ข้อมูลรับรอง API ในคอลัมน์ คีย์ API ให้คลิกที่ สร้าง
การเชื่อมต่อที่สร้างขึ้นใหม่จะแสดงเป็นแถวในตารางข้อมูลรับรอง API ก่อนที่จะมีการสร้างคีย์ API
-
เมื่อคุณคลิกปุ่ม สร้าง ภายในแถวที่ต้องการ คุณจะเห็นรายการขอบเขต API ที่คุณสามารถเลือกได้
การเลือกขอบเขตควรสอดคล้องกับ API endpoints ที่คุณวางแผนจะใช้ ดูข้อมูลเพิ่มเติมได้ที่ เกี่ยวกับ Cloudbeds API
-
เลือกขอบเขตที่ต้องการโดยทำเครื่องหมายในแต่ละสิทธิ์ จากนั้นคลิก สร้าง
กล่องโต้ตอบคีย์ API ใหม่จะแบ่งกลุ่มสิทธิ์ที่มีให้เลือก ได้แก่ อ่าน เขียน และลบ ตามขอบเขต API
-
เลือกที่พักที่คุณต้องการให้แอปพลิเคชันเชื่อมต่อ เลือก เชื่อมต่อที่พักทั้งหมด เพื่อสร้างคีย์ที่ใช้ได้กับที่พักทั้งหมดใน องค์กร แล้วคลิก ดำเนินการต่อ
-
ตรวจสอบสิทธิ์ที่แอปพลิเคชันร้องขอ จากนั้นคลิก อนุญาตการเข้าถึง
หน้าการรับรองจะแสดงรายการขอบเขตสิทธิ์ที่จะถูกแชร์กับแอปพลิเคชันก่อนที่จะได้รับการอนุญาตเข้าถึง
-
Cloudbeds จะสร้างคีย์ API หลังจากได้รับการรับรองแล้ว
คัดลอกและเก็บคีย์ API ทันที คีย์ API ฉบับสมบูรณ์จะแสดงเพียงครั้งเดียวเมื่อสร้างขึ้นเท่านั้น เมื่อคุณปิดกล่องโต้ตอบนี้ไปแล้ว จะไม่สามารถดูคีย์ API นั้นอีก เก็บไว้ในตัวจัดการข้อมูลประจำตัวที่ปลอดภัยหรือสถานที่ปลอดภัยอื่นๆ
กล่องโต้ตอบ คีย์ API ที่สร้างขึ้น จะแสดงคีย์พร้อมกับคำเตือนว่าจะไม่สามารถดูคีย์นี้ได้อีกหลังจากปิดกล่องโต้ตอบ
2. การใช้คีย์ API ของคุณ
ตอนนี้คุณสามารถใช้คีย์ API เพื่อเข้าถึง Cloudbeds API โดยการใส่คีย์ API ในส่วนหัวของคำขอเป็น x-api-key หรือเป็น bearer token ได้
ตัวอย่างเช่น:
curl --location '<https://hotels.cloudbeds.com/api/v1.2/getHotels'> \--header 'Authorization: Bearer cbat_EE*** ' \
curl --location '<https://hotels.cloudbeds.com/api/v1.2/getHotels'> \--header 'x-api-key: cbat_EE*** ' \
3. การลบหรือแทนที่คีย์ API
คุณสามารถลบหรือสร้างคีย์ใหม่ได้ทุกเมื่อ ในตาราง ข้อมูลรับรอง API ให้ค้นหาคอลัมน์ คีย์ API และใช้การดำเนินการที่มีสำหรับคีย์นั้น
ตารางข้อมูลรับรอง API จะเก็บคีย์ API ที่บันทึกไว้ในรูปแบบที่ถูกซ่อนไว้หลังจากสร้างแล้ว
เมื่อคีย์ถูกลบหรือสร้างใหม่ คีย์เก่าจะไม่สามารถใช้เข้าถึง API ได้อีกต่อไป
คำถามที่พบบ่อย (FAQ)
คีย์ API หมดอายุไหม?
คีย์จะไม่หมดอายุ ตราบใดที่มีการใช้งานอย่างน้อยหนึ่งครั้งทุก 30 วัน
จะเพิ่มขอบเขตการอนุญาตเพิ่มเติมหลังจากสร้างคีย์ API อย่างไร?
เข้าไปที่แท็บ ข้อมูลรับรอง API ค้นหาคอลัมน์ คีย์ API สำหรับข้อมูลรับรอง API ที่เกี่ยวข้อง แล้วคลิกปุ่มถังขยะเพื่อลบคีย์ API
หลังจากลบแล้ว คุณสามารถสร้างคีย์ API ใหม่ที่มีขอบเขตการอนุญาตที่ถูกต้องได้
จะเพิ่มคีย์ API ใน Postman ได้อย่างไร?
คุณสามารถใส่คีย์ API ของคุณในแท็บการรับรองสิทธิ์ของ Postman เป็น API key หรือ Bearer token
คีย์ API รองรับสำหรับบัญชีองค์กร/กลุ่มในระดับที่พักหรือไม่?
ผู้ใช้องค์กร ที่ต้องการเปิดใช้งานการเข้าถึง API สำหรับหลายที่พัก สามารถเลือก เปิดใช้งานสำหรับทั้งองค์กร เมื่อกรอกแบบฟอร์ม การรวม API ใหม่ ใน ขั้นตอนที่ 4 ของการสร้างข้อมูลรับรอง API จากนั้นในระหว่างการรับรองสิทธิ์ พวกเขาสามารถเลือกที่พักที่แอปพลิเคชันควรเชื่อมต่อได้
เก็บคีย์ API ให้ปลอดภัย Cloudbeds พยายามอย่างสมเหตุสมผลเพื่อให้แน่ใจว่าคีย์ API จะไม่ถูกเปิดเผยในที่เก็บข้อมูลสาธารณะ เช่น GitHub หรือ GitLab หากคีย์ API ถูกเปิดเผยสู่สาธารณะ Cloudbeds อาจปิดใช้งานคีย์นั้นและขอให้คุณสร้างคีย์ใหม่และอัปเดตการรวมของคุณ
- สำหรับข้อมูลเพิ่มเติมเกี่ยวกับนโยบาย การกำหนดราคา และกรณีการใช้งาน โปรดดูที่ การเข้าถึง API สำหรับที่พักและบัญชีกลุ่ม
ข้อคิดเห็น
โปรด ลงชื่อเข้าใช้ เพื่อแสดงข้อคิดเห็น