ข้ามไปที่เนื้อหาหลัก

API สำหรับนักพัฒนาและเว็บฮุก

สร้างคีย์ API ลงทะเบียนปลายทางเว็บฮุก และตรวจสอบบันทึกคำขอจากศูนย์นักพัฒนา

เขียนโดย Sarah Chen

Developer Center คือที่ที่คุณเชื่อม Exayard เข้ากับโค้ดและเครื่องมือของคุณเอง เปิดได้จาก การตั้งค่า แล้วไปที่ Developer จากที่นี่คุณสร้าง API key ลงทะเบียน webhook endpoint และตรวจสอบบันทึกแบบสดของคำขอ API ทุกรายการ มีเพียงผู้ดูแลระบบขององค์กรเท่านั้นที่เข้าถึงหน้านี้ได้

API key

API key ใช้ยืนยันตัวตนของคำขอที่ส่งไปยัง Exayard API คีย์เป็นของแต่ละองค์กร ดังนั้นบัญชีที่ถูกต้องจะถูกเลือกโดยอัตโนมัติและไม่ต้องส่งรหัสองค์กร

เปิดแท็บ API keys ในการ์ด Credentials แล้วคลิกปุ่ม + ตั้ง ชื่อ ให้คีย์ จากนั้นเลือก ขอบเขตสิทธิ์ เลือก ทั้งหมด เพื่อให้ทุกขอบเขตสิทธิ์ หรือ เฉพาะเจาะจง เพื่อเลือกสิทธิ์แต่ละรายการ ขอบเขตสิทธิ์จะแบ่งเป็นการอ่านและการเขียนต่อทรัพยากร เช่น read:projects และ write:estimates ขอบเขต admin:org คือสิทธิ์การเข้าถึงเต็มรูปแบบ เลือกขอบเขตสิทธิ์ขั้นต่ำที่การเชื่อมต่อของคุณต้องการ

Exayard จะแสดงคีย์เต็มเพียงครั้งเดียว ทันทีหลังจากที่คุณสร้าง คัดลอกไว้ตอนนั้น เพราะจะไม่แสดงอีกเลย หลังจากนั้น คีย์แต่ละรายการจะปรากฏพร้อมชื่อ ตัวอย่างแบบปิดบัง เช่น ak_••••1234 และวันที่ใช้งานล่าสุด

ใช้ไอคอนดินสอเพื่อเปลี่ยนชื่อคีย์หรือเปลี่ยนขอบเขตสิทธิ์ ใช้ไอคอนถังขยะเพื่อ เพิกถอน คีย์ การเพิกถอนเป็นการถาวรและการเชื่อมต่อใด ๆ ที่ใช้คีย์นั้นจะหยุดทำงานทันที

คีย์เดียวกันนี้ยืนยันตัวตนของการเชื่อมต่อแบบไม่ต้องเขียนโค้ด ดู การเชื่อมต่อ Exayard กับ Zapier, การเชื่อมต่อ Exayard กับ Make และ การเชื่อมต่อ Exayard กับ n8n สำหรับการเข้าถึงโดยตัวแทนและโปรแกรมแก้ไข AI ดู การเชื่อมต่อกับ Claude และเครื่องมือ AI อื่น ๆ

Webhook

webhook บอกให้ Exayard แจ้งเตือนเซิร์ฟเวอร์ของคุณเมื่อมีบางอย่างเกิดขึ้น เปิดแท็บ Webhooks แล้วคลิก + เพื่อเพิ่ม endpoint ป้อน URL ที่ควรได้รับการส่งข้อมูลและ คำอธิบาย ที่เป็นทางเลือก

เลือกว่าจะสมัครรับ เหตุการณ์ ใดบ้าง เลือก ทั้งหมด เพื่อรับทุกเหตุการณ์ หรือ เฉพาะเจาะจง เพื่อเลือกจากรายการ:

เหตุการณ์

เกิดขึ้นเมื่อ

project.created

มีการสร้างโครงการ

project.updated

มีการเปลี่ยนแปลงโครงการ

project.archived

มีการเก็บถาวรโครงการ

assessment.started

การประเมินการถอดปริมาณเริ่มต้น

assessment.completed

การประเมินเสร็จสิ้น

assessment.approved

การประเมินได้รับการอนุมัติ

assessment.cancelled

การประเมินถูกยกเลิก

estimate.generated

มีการสร้างใบประมาณราคา

bid.generated

มีการสร้างใบเสนอราคา

file.processed

ไฟล์ที่อัปโหลดประมวลผลเสร็จสิ้น

เมื่อคุณสร้าง endpoint Exayard จะแสดง signing secret เพียงครั้งเดียว คัดลอกไว้ตอนนั้น เพราะจะไม่แสดงอีก

การรักษาความปลอดภัยการส่งข้อมูล webhook

การส่งข้อมูลทุกครั้งจะมีส่วนหัว Exayard-Signature ในรูปแบบ t=<unix>,v1=<digest> Exayard สร้างลายเซ็นด้วยการรวมเวลาประทับเข้ากับเนื้อหาคำขอ จากนั้นลงนามด้วย HMAC-SHA256 โดยใช้ secret ของ endpoint ของคุณ

หากต้องการตรวจสอบยืนยันการส่งข้อมูล ให้คำนวณลายเซ็นใหม่ด้วย secret ของคุณ ยืนยันว่าเวลาประทับอยู่ภายในห้านาทีจากตอนนี้ และเปรียบเทียบ digest การส่งข้อมูลที่ล้มเหลวจะลองส่งซ้ำด้วย exponential backoff เป็นเวลาประมาณสามวัน

หากต้องการแก้ไข endpoint ให้คลิกไอคอนดินสอ คุณสามารถเปลี่ยน URL คำอธิบาย และเหตุการณ์ได้ และตั้ง สถานะ เป็น ใช้งานอยู่ หรือ หยุดชั่วคราว endpoint ที่หยุดชั่วคราวจะหยุดรับการส่งข้อมูล หน้าต่างเดียวกันนี้มีปุ่ม หมุน secret การหมุนจะออก secret ใหม่และอันเก่าจะหยุดทำงานทันที ดังนั้นให้อัปเดตเซิร์ฟเวอร์ของคุณก่อนที่จะหมุน ไอคอนถังขยะจะลบ endpoint และยุติการส่งข้อมูลทั้งหมดไปยัง endpoint นั้น

เริ่มต้นอย่างรวดเร็ว

การ์ด Quick start มี prompt สำเร็จรูปสำหรับโปรแกรมแก้ไข AI อย่าง Claude หรือ Cursor คลิก คัดลอก prompt แล้ววางลงในโปรแกรมแก้ไขของคุณ prompt นี้ประกอบด้วย API base URL รูปแบบการยืนยันตัวตน คำศัพท์ขอบเขตสิทธิ์ และโครงร่างการลงนาม webhook เพื่อให้ AI สามารถสร้างโครงสร้างการเชื่อมต่อที่ใช้งานได้และขอรายละเอียดที่ต้องการจากคุณ

เอกสารประกอบ

การ์ด Documentation เชื่อมไปยังเอกสารสำหรับนักพัฒนาฉบับเต็มและ OpenAPI spec ซึ่งอธิบายทุก route และ schema Connect MCP จะเปิดการตั้งค่าสำหรับการเชื่อมต่อตัวแทน AI เข้ากับ Exayard โดยตรง

บันทึก

ส่วน Logs บันทึกคำขอ API ล่าสุดของคุณทั้งใน REST API และ MCP แต่ละแถวแสดงเมธอด เส้นทาง สถานะการตอบกลับ และเวลาแฝง เลือกแถวเพื่อดูรายละเอียดเต็ม รวมถึง request ID และเนื้อหาคำขอกับการตอบกลับ ใช้บันทึกเพื่อยืนยันว่าการเรียกใช้ทำงานสำเร็จหรือเพื่อแก้ไขข้อบกพร่องของการเชื่อมต่อที่ล้มเหลว

นี่ไม่ใช่คำตอบที่ต้องการใช่ไหม