การยืนยันตัวตน
การใช้งาน Meshy API จำเป็นต้องผ่านการยืนยันตัวตน คู่มือนี้จะแสดงวิธีการสร้างบัญชีและ API คีย์
API Keys
การสร้างบัญชี Meshy
Meshy API กำหนดให้คุณต้องมีบัญชี Meshy เพื่อสร้างและจัดการ API คีย์ หากมีการเรียกคำขอไปยัง API โดยไม่มี API คีย์ API จะตอบกลับด้วยข้อผิดพลาดเกี่ยวกับข้อมูลยืนยันตัวตนที่ไม่ถูกต้อง
คุณสามารถสร้างบัญชี Meshy ได้โดยเข้าไปที่ เว็บไซต์ทางการของ Meshy แล้วสมัครสมาชิก
การสร้าง API Keys
เมื่อคุณสร้างบัญชี Meshy แล้ว คุณสามารถสร้าง API คีย์ได้ที่ หน้า API Keys ใน Developer Platform
คุณสามารถสร้าง API คีย์หลายตัวสำหรับวัตถุประสงค์ที่แตกต่างกันได้ ตัวอย่างเช่น คุณสามารถสร้าง API คีย์หนึ่งสำหรับแอป iOS ของคุณ และอีกตัวสำหรับเว็บแอปของคุณ การใช้งานของ API คีย์แต่ละตัวจะถูกติดตามแยกกัน และคุณสามารถเพิกถอนได้ทุกเมื่อ
คุณยังสามารถตั้งค่าขีดจำกัด credit รายเดือนสำหรับคีย์ใดก็ได้ เพื่อจำกัดว่าคีย์นั้นจะใช้จ่ายได้มากเท่าใด โดยไม่คำนึงถึงการใช้งานโดยรวมของบัญชีคุณ ซึ่งมีประโยชน์สำหรับการจำกัดขอบเขตคีย์ที่คุณมอบให้กับผู้รับเหมาหรือสภาพแวดล้อมเฉพาะ
หากต้องการสร้าง API คีย์ ให้คลิกที่ปุ่ม Create API Key บนหน้า API แล้วป้อนชื่อสำหรับ API คีย์ของคุณ
เมื่อคุณสร้าง API คีย์แล้ว ระบบจะแสดงค่า API คีย์ให้คุณเห็น คุณสามารถคัดลอกค่า API คีย์และจัดเก็บไว้ในที่ที่ปลอดภัยได้
คุณจะไม่สามารถดูค่า API คีย์นี้ได้อีกครั้ง
การใช้งาน API Keys
เมื่อคุณสร้าง API คีย์แล้ว คุณสามารถใช้มันเพื่อยืนยันตัวตนสำหรับคำขอของคุณไปยัง
Meshy API คุณสามารถส่ง API คีย์ของคุณไปยัง API ใน header Authorization
ตัวอย่าง header แสดงไว้ด้านล่างนี้
{
"Authorization": "Bearer msy_sOmEbOgUsApIkEyFoReXaMpLe1234567890"
}
คำนำหน้า Bearer ในค่าของ header เป็นสิ่งจำเป็นในการติดต่อกับ Meshy API แบบโปรแกรม
คุณสามารถเรียนรู้เพิ่มเติมเกี่ยวกับเรื่องนี้ได้ที่ IETF RFC 6750
Security
เราให้ความสำคัญกับความปลอดภัยอย่างจริงจังที่ Meshy และเราทำงานอย่างหนักเพื่อให้แน่ใจว่า Meshy API มีความปลอดภัย เราหวังว่าข้อมูลของคุณและข้อมูลของผู้ใช้ของคุณจะปลอดภัยกับเรา นี่คือแนวทางระดับสูงบางประการที่จะช่วยให้คุณรักษาความปลอดภัยของข้อมูลและคำขอของคุณเมื่อใช้งาน Meshy API แต่โปรดตรวจสอบให้แน่ใจว่าได้ปฏิบัติตามแนวทาง ที่ใช้ในทีมหรือสถานที่ทำงานของคุณด้วยเช่นกัน
Transport Layer Security
แม้ว่าข้อมูลของคุณจะถูกเข้ารหัสขณะพักเมื่อถูกจัดเก็บใน Meshy แล้ว Meshy API ใช้และบังคับใช้ TLS
เพื่อเข้ารหัสข้อมูลระหว่างการส่ง ซึ่งหมายความว่าคำขอทั้งหมดที่ส่งไปและมาจาก Meshy API จะถูกส่งผ่าน HTTPS และคำขอใดๆ ที่ส่งผ่าน HTTP จะได้รับรหัสสถานะ 301 Moved Permanently
แม้จะไม่แนะนำ แต่ในบางกรณี หากคุณจำเป็นต้องสื่อสารผ่าน HTTP คุณจะต้องบอก HTTP client ของคุณอย่างชัดเจนให้ทำตามการเปลี่ยนเส้นทางจาก HTTP ไปยัง HTTPS นี่คือตัวอย่างบางส่วน:
Follow HTTP to HTTPS redirections
# use `-L` to follow HTTP to HTTPS redirections
curl -L https://api.meshy.ai/openapi/v1/balance \
-H "Authorization: Bearer ${YOUR_API_KEY}"
การเปลี่ยนเส้นทางใช้ได้เฉพาะกับคำขอ GET เท่านั้น: HTTP client จะส่งคำขอ POST ที่ถูกเปลี่ยนเส้นทางใหม่อีกครั้งในรูปแบบ GET โดยไม่มี body ดังนั้นควรเรียกใช้ https:// โดยตรงเสมอเมื่อสร้างงาน
API Key Safety
โปรดทราบว่าแม้แต่ทีมงาน Meshy เองก็ไม่สามารถดูหรือกู้คืน API คีย์ที่ถูกเพิกถอนให้คุณได้!
เมื่อถูกสร้างขึ้นแล้ว API คีย์จะไม่ปรากฏให้เห็นในแดชบอร์ดอีกต่อไป ดังนั้นโปรดดาวน์โหลดและเก็บรักษาไว้อย่างปลอดภัยและมั่นคง เนื่องจากใครก็ตามที่ได้รับมันไป สามารถใช้มันเพื่อติดต่อกับ Meshy API ในนามของคุณได้ หากคุณเชื่อว่า API คีย์ของคุณถูกบุกรุก คุณสามารถเพิกถอนได้ทุกเมื่อจากแดชบอร์ด เมื่อถูกเพิกถอนแล้ว มันจะไม่สามารถใช้งานได้อีกต่อไป
Security Disclosure
หากคุณเชื่อว่าคุณได้ค้นพบปัญหาด้านความปลอดภัยใน Meshy API โปรด ติดต่อเรา เราขอขอบคุณสำหรับการเปิดเผยข้อมูลอย่างมีความรับผิดชอบของคุณ และจะพยายามอย่างเต็มที่เพื่อตอบรับการมีส่วนร่วมของคุณ