REST API ให้การเข้าถึงข้อมูลของบริษัทผ่านโปรแกรม เหมาะสำหรับนักพัฒนาที่สร้างการเชื่อมต่อ คุณไม่จำเป็นต้องใช้ในการทำงานประจำวัน
- เอกสารอ้างอิง API: เอกสารอ้างอิงฉบับเต็มเปิดเป็นสาธารณะที่ /docs/api บนที่อยู่พื้นที่ทำงานของคุณ โดยมีเอกสาร OpenAPI ที่ /docs/api/openapi.yaml และ /docs/api/openapi.json API และ webhook ในการตั้งค่ามีลิงก์ไปยังเอกสารนี้
- URL พื้นฐาน: แสดงที่ด้านบนของ API และ webhook ลงท้ายด้วย /api/v1
- การยืนยันตัวตน: ส่งส่วนหัว Authorization: Bearer ตามด้วยโทเค็นของคุณ และ Accept: application/json
- การตอบกลับ: JSON เท่านั้น ระเบียนเดี่ยวจะห่อใน data รายการจะเพิ่ม meta และ links สำหรับการแบ่งหน้าแบบ cursor (พารามิเตอร์ limit และ cursor สูงสุด 100 รายการต่อหน้า)
- การลองใหม่อย่างปลอดภัย: ส่งส่วนหัว Idempotency-Key ในคำขอ POST การส่งคำขอเดิมซ้ำด้วยคีย์เดิมจะคืนการตอบกลับที่เก็บไว้แทนการสร้างระเบียนที่สอง คีย์จะถูกเก็บไว้ 24 ชั่วโมง
- ขีดจำกัดอัตรา: 120 คำขอต่อนาทีต่อโทเค็น ส่วนหัว X-RateLimit-Limit และ X-RateLimit-Remaining แสดงสถานะของคุณ หากเกินขีดจำกัดจะได้รับ 429 พร้อมส่วนหัว Retry-After
สิ่งที่คำขอทำได้
การเรียกจะสำเร็จเฉพาะเมื่อโทเค็นมีสิทธิ์ (เช่น invoices:write) และผู้ใช้ของโทเค็นมีสิทธิ์ที่ตรงกันในแอป กฎทางธุรกิจเดียวกับบนหน้าจอมีผลบังคับใช้ ดังนั้นใบแจ้งหนี้ที่ออกแล้วจึงแก้ไขผ่าน API ไม่ได้เช่นกัน
คู่มือที่เกี่ยวข้อง
ถามเกี่ยวกับผลิตภัณฑ์
ถามว่าซอฟต์แวร์ทำอะไรได้บ้าง งานต่าง ๆ ทำงานอย่างไร หรือรองรับประเทศและภาษาใดบ้าง คำตอบมาจากคู่มือเหล่านี้
AI อาจผิดพลาดได้ โปรดตรวจสอบคู่มือที่ลิงก์ไว้
ยังต้องการความช่วยเหลือ?
ทีมสนับสนุนของเราอ่านทุกข้อความและตอบด้วยภาษาที่เข้าใจง่าย
ติดต่อฝ่ายสนับสนุน