คำแนะนำ

API สำหรับนักพัฒนา

เชื่อมซอฟต์แวร์ผ่านการดำเนินการที่ระบุชัดเจนสำหรับแหล่งข้อมูล การประมวลผล ผลลัพธ์ และการจัดการ คู่มือนี้อธิบาย API ที่พร้อมใช้งานภายในข้อจำกัดของรุ่นที่ระบุไว้ ผู้ใช้ สิทธิ์ พื้นที่จัดเก็บ และเครดิตยังผูกกับบัญชี Rapportly

เตรียมการเชื่อมต่อในสามขั้นตอน

1. 1
   เลือกผู้ใช้ สภาพแวดล้อม และสิทธิ์

   เปิด บัญชี → การเชื่อมต่อ ใช้คีย์ทดสอบสำหรับตัวจำลอง และใช้คีย์ระบบจริงแยกต่างหากสำหรับการดำเนินการจริงด้วยข้อมูลสมมติ ผู้ดูแลกำหนดเฉพาะสิทธิ์ที่จำเป็นและงบประมาณที่เหมาะสม

2. 2
   ฝึกการรับคำขอและจัดการข้อผิดพลาด

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

3. 3
   ติดตามงานให้ครบทุกขั้นตอน

   เก็บข้อมูลเข้าและรหัสงาน ตรวจสอบการเริ่มและสถานะสุดท้าย อ่านผลลัพธ์ ดาวน์โหลดไฟล์ที่พร้อม และตรวจสอบการใช้เครดิต ทำการทดลองนี้เฉพาะในสภาพแวดล้อมที่ได้รับอนุญาต

สร้างคีย์ API

ที่อยู่หลัก

https://api.rapportly.io/api/rapportly/v1

คีย์เป็นของผู้ใช้คนหนึ่ง

คีย์มอบหมายสิทธิ์ของผู้ใช้หนึ่งคน ผู้ดูแลกำหนดสภาพแวดล้อม เพดานสิทธิ์ งบรายเดือน และวันหมดอายุ สมาชิกเปิดใช้คีย์ที่เตรียมไว้และเห็นค่าลับครั้งเดียว ทุกคำขอตรวจสอบสิทธิ์ปัจจุบันของผู้ใช้ แพ็กเกจ และวัตถุด้วย การจัดการคีย์ใช้เซสชันผู้ใช้ ส่วนการดำเนินการจริงใช้คีย์ API เก็บข้อมูลลับบนเซิร์ฟเวอร์และเพิกถอนคีย์ที่หายผ่าน บัญชี → การเชื่อมต่อ เหตุการณ์ Zapier มีข้อกำหนดแยกต่างหาก

GET https://api.rapportly.io/api/rapportly/v1/ping
Authorization: Bearer rply_<jouw_sleutel>

ใช้ข้อกำหนดและตัวอย่างที่ชัดเจน

OpenAPI สำหรับระบบจริงอธิบายข้อกำหนดจากโค้ดและระบุข้อมูลเข้าหรือคำตอบที่ยังไม่ครบ รายการแสดงสคีมาที่ยังเปิดอยู่ คอลเลกชัน Postman เริ่มด้วยที่อยู่ที่ใช้ไม่ได้ คีย์ว่าง และปิดการเปลี่ยนแปลง นำเข้าเพื่อทบทวน แล้วส่งข้อมูลสมมติโดยตั้งใจในสภาพแวดล้อมที่ได้รับอนุญาต การนำเข้ายังไม่ผ่านการทดสอบ

• ดาวน์โหลดข้อกำหนด OpenAPI สำหรับระบบจริง
• ดาวน์โหลดคอลเลกชัน Postman แบบข้อมูลสมมติ
• ดาวน์โหลดขั้นตอนจากแหล่งข้อมูลถึงการดาวน์โหลด
• ดาวน์โหลดรายการสคีมาและส่วนที่ยังไม่เสร็จ

ฝึกด้วยงานสมมติก่อน

สร้างคีย์ทดสอบแล้วฝึกงานที่กำลังทำ ผลลัพธ์ ข้อผิดพลาด และงบไม่พอ ตัวจำลองใช้ตัวอย่างคงที่และไม่คิดเครดิต

1. สร้างหรือเปิดใช้คีย์ Test ใน บัญชี → การเชื่อมต่อ พร้อมสิทธิ์ที่ต้องการฝึก
2. เรียก GET /test/scenarios และเลือกการดำเนินการจากคำตอบ รายการนี้อิงสิทธิ์ปัจจุบันของคุณ
3. ส่ง POST /test/opdrachten โดยมีเพียง actie และ scenario: succes, verwerking_mislukt, creditbudget_bereikt หรือ toegang_geweigerd งานฝึกใหม่แต่ละงานใช้ Idempotency-Key ของตนเอง
4. เก็บ opdracht_id เมื่อเป็น bezig ให้อ่าน GET /test/opdrachten/{id} หลังประมาณห้าวินาที ตรวจสถานะเสมอ เพราะ HTTP200 อาจมีการประมวลผลล้มเหลวได้

POST https://api.rapportly.io/api/rapportly/v1/test/opdrachten
Authorization: Bearer rply_test_<jouw_testsleutel>
Idempotency-Key: test-rapport-0001
Content-Type: application/json

{
  "actie": "rapport.start",
  "scenario": "succes"
}

ตัวอย่างนี้ต้องมี rapport.start ในรายการของคุณ เมื่อการเชื่อมต่อมีปัญหาให้ส่งข้อมูลและ Idempotency-Key เดิมซ้ำ

• ดาวน์โหลดคู่มือตัวจำลอง
• ดาวน์โหลดคอลเลกชัน Postman สำหรับฝึก
• ดาวน์โหลด OpenAPI ของตัวจำลอง

ดึงเฉพาะข้อมูลที่ต้องการ

ค้นหาโฟลเดอร์ลูกค้า บทสนทนา และรายงานที่เข้าถึงได้ /acties แสดงการดำเนินการและสิทธิ์ /gebruik แสดงงบและยอดสำรอง /verzoeken แสดงประวัติคำขอทางเทคนิค งานที่กำลังประมวลผลยังไม่มีผลลัพธ์ ลิงก์รายงานใช้ได้ 15 นาที อ่านรายงานอีกครั้งเพื่อรับลิงก์ใหม่

อัปเดตการจัดการลูกค้า

ซอฟต์แวร์ของคุณสามารถแก้ไขเทมเพลตสำนักงาน บันทึกการค้นหาส่วนตัว บันทึกการเยี่ยม และสร้างกระบวนการติดตามได้ ใช้สิทธิ์การจัดการที่เหมาะสมและยืนยันการเปลี่ยนแปลงทุกครั้ง อ่านเวอร์ชันปัจจุบันก่อน และเก็บรหัสคำขอเดิมไว้หากการตอบกลับสูญหาย การส่งคำขอเก่าซ้ำต้องไม่ย้อนการเปลี่ยนแปลงที่ใหม่กว่า การทดสอบในระบบจริงตรวจสอบการค้นหา การเยี่ยม และกระบวนการติดตาม รวมถึงการล้างข้อมูลทดสอบและการเพิกถอนคีย์ เทมเพลตสำนักงานได้รับการทดสอบเฉพาะการอ่าน ส่วนการเขียนผ่านการทดสอบในเครื่องและใน CI คู่มือที่ดาวน์โหลดได้อธิบายทั้งสี่เส้นทางและขอบเขตหลักฐานของแต่ละเส้นทาง

เปรียบเทียบสองเวอร์ชันที่บันทึกไว้

เปรียบเทียบหมายเลขเวอร์ชันที่มีอยู่สองหมายเลขของฟิลด์ข้อความรายงานหรือฟิลด์การสนทนาเดียวกันที่บันทึกไว้ โดยไม่เริ่มการประมวลผลด้วย AI ใหม่ สัญญา API นี้ผ่านการทดสอบในเครื่องและใน CI แล้ว การทดสอบ CRM ในระบบจริงไม่ได้พิสูจน์การทำงานของการเปรียบเทียบในระบบจริง ระบบจะไม่ใช้ข้อความปัจจุบันเติมแทนประวัติที่ขาดหาย ความแตกต่างที่ยาวจะถูกตัดให้เหลือไม่เกิน 8000 อักขระต่อด้าน พร้อมระบุให้เห็นอย่างชัดเจน การเปรียบเทียบนี้ไม่ครอบคลุม PowerPoint การคำนวณใบเสนอราคา จดหมายนำส่ง หรือการจัดรูปแบบ สิทธิ์ในการอ่านและเงื่อนไขความเป็นส่วนตัวปัจจุบันยังคงมีผล

ขอประมาณการค่าใช้จ่ายล่วงหน้า

POST /generatieplan แสดงขั้นตอนและเครดิตที่คาดสำหรับรายงาน ใบเสนอราคา หรือชุดบทสนทนา ใช้สิทธิ์ gebruik:lezen การคำนวณและค่าทีมเหมือนเว็บไซต์

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

ดาวน์โหลดคู่มือประมาณการและตัวอย่าง

เริ่มประมวลผลจากซอฟต์แวร์ของคุณ

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

สร้างแฟ้มก่อน

สร้าง UUID และเก็บไว้ ส่ง PUT /dossiers/{id} พร้อม naam เท่านั้น ไม่เกิน 200 ตัวอักษร 201 หมายถึงสร้างใหม่ 200 คือการส่งซ้ำที่เหมือนเดิม แฟ้มเป็นของผู้ใช้และองค์กรของคีย์และไม่ใช้เครดิต ข้อมูลต่างกันคืน 409 แฟ้มที่เข้าถึงไม่ได้หรือถูกลบคืน 404 GET /dossiers/{id} อ่าน naam และ klant_id ด้วยสิทธิ์อ่าน

PUT https://api.rapportly.io/api/rapportly/v1/dossiers/00000000-0000-4000-8000-000000000002
Authorization: Bearer rply_<jouw_sleutel>
Content-Type: application/json

{ "naam": "Voorbeeldproject" }

รายงาน ใบเสนอราคา หรือสไลด์นำเสนอ

เริ่มด้วย dossierId และ notities ระบุ tier ได้เป็น basis, standaard หรือ max หากไม่มีโปรไฟล์รูปแบบจะใช้การจัดหน้ากลาง คุณอาจเพิ่ม stijlprofielId, klantId, bronOpnameIds และ taal ที่เข้าถึงได้ รูปแบบต้องตรงกับประเภทเอกสาร ใบเสนอราคาใช้ค่าบริษัทและการกำหนดเลขอย่างปลอดภัย API ไม่ส่งใบเสนอราคาให้ลูกค้า

POST https://api.rapportly.io/api/rapportly/v1/rapporten
Authorization: Bearer rply_<jouw_sleutel>
Idempotency-Key: crm-rapport-2026-0001
Content-Type: application/json

{
  "dossierId": "00000000-0000-4000-8000-000000000002",
  "notities": "Team Atlas besprak de training. Noor plant de volgende bijeenkomst op donderdag.",
  "tier": "standaard"
}

เก็บ versie_id และติดตาม GET /rapporten/{versie_id} รวมถึงใบเสนอราคาและงานนำเสนอ เมื่อเป็น klaar วัตถุ resultaat จะมีไฟล์ที่พร้อม: export_url สำหรับ PDF, export_url_docx สำหรับ Word และ export_url_pptx สำหรับ PowerPoint ลิงก์ใช้ได้ 15 นาที เมื่อเป็น mislukt ให้ตรวจการประมวลผลและการใช้เครดิตก่อนเริ่มงานใหม่อัตโนมัติด้วยคีย์อื่น

ดาวน์โหลดขั้นตอนจากแหล่งข้อมูลถึงการดาวน์โหลด

อัปโหลดตัวอย่างรูปแบบของคุณ

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

1. ส่งไฟล์ ชื่อ ประเภทเอกสาร ขอบเขตส่วนตัวหรือทีม การยืนยันชัดเจน และรหัสงานคงที่ รูปแบบทีมต้องเป็นผู้ดูแลหรือหัวหน้าทีม
2. เก็บรหัสรับคำขอและอ่านสถานะ รับแล้วหมายถึงเก็บชุดครบถ้วนแล้ว การตรวจตัวอย่างและอนุมัติอาจตามมาภายหลัง
3. หลังขาดการเชื่อมต่อ ให้ส่งคำขอเดิมซ้ำโดยไม่สร้างรูปแบบที่สอง การอัปโหลดไม่ครบสามารถส่งซ้ำได้สามสิบวัน แล้วจึงล้างอย่างมีการควบคุม

ดาวน์โหลดคู่มือตัวอย่างรูปแบบ multipart และข้อผิดพลาด

เชื่อมปฏิทินหรือกล่องจดหมาย

ผู้ใช้ให้ความยินยอมที่ Google หรือ Microsoft ด้วยตนเอง โปรแกรมติดตามคำขอและตัดการเชื่อมต่อโดยตั้งใจได้ รหัสผ่านและโทเคนของผู้ให้บริการไม่อยู่ในคำตอบ

ใช้ verbindingen:beheren สำหรับการเชื่อมต่อ และ agenda:lezen สำหรับนัดหมาย การส่งต้องมีสิทธิ์ส่งและคำขอที่ชัดเจนเพิ่มเติม

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

API เลือกกล่องจดหมายเริ่มต้นได้ด้วยสิทธิ์จัดการและส่ง อ่านตัวเลือกกับการเชื่อมต่อปัจจุบันก่อน การส่งซ้ำเก่าไม่เปลี่ยนตัวเลือกใหม่กว่า งานส่งที่มีอยู่เก็บผู้ส่งเดิมไว้

ดาวน์โหลดขั้นตอนยินยอม นัดหมาย ตัดการเชื่อมต่อ และกู้คืน

สร้างผลลัพธ์บทสนทนาจากข้อความ

ส่งข้อความถอดเสียงอย่างน้อยหนึ่งร้อยตัวอักษร ติดตามผลด้วย gesprek_id ฟิลด์ที่เลือกเพิ่มได้: titel, tier, klantId และ taal

POST https://api.rapportly.io/api/rapportly/v1/gesprekken
Authorization: Bearer rply_<jouw_sleutel>
Idempotency-Key: crm-gesprek-2026-0001
Content-Type: application/json

{
  "transcript": "Team Atlas bespreekt uitsluitend een fictieve oefening. Het team plant een training en verzamelt algemene voorbeeldvragen zonder klantgegevens.",
  "titel": "Kennismaking"
}

อ่านฉบับภาษาที่มีอยู่

อ่านผลลัพธ์ภาษาที่มีอยู่ เส้นทางเวิร์กโฟลว์ที่อธิบายไว้สำหรับการเริ่ม หยุดชั่วคราว ดำเนินต่อ และกู้คืน ผ่านการทดสอบในเครื่องและใน CI แล้ว การทดสอบ CRM ในระบบจริงไม่ได้ยืนยันการประมวลผลภาษานี้ ใช้เส้นทางเหล่านี้เฉพาะในสภาพแวดล้อมที่ได้รับอนุมัติสำหรับวัตถุประสงค์นี้เท่านั้น ผู้ใช้ คีย์ แหล่งข้อมูล และค่าใช้จ่ายเดิมยังคงผูกกับคำขอ ยังต้องมีสถานะปัจจุบันของแหล่งข้อมูล สิทธิ์ งบประมาณ และการชำระบัญชีที่ตรวจสอบแล้ว แหล่งข้อมูลที่หมดอายุหรือถูกลบไม่ให้สิทธิ์เริ่มใหม่ การประมวลผลแบบกลุ่มที่เปิดใช้ภาษาที่สองยังคงปิดอยู่ รวมถึงกรณีที่สืบทอดการตั้งค่ามา การจ่ายเงินเพื่อเติมผลลัพธ์การแปลที่ขาดหายเพียงรายการเดียวยังไม่อยู่ในขอบเขตที่รองรับ

GET https://api.rapportly.io/api/rapportly/v1/gesprekken/00000000-0000-4000-8000-000000000001/taalvarianten
Authorization: Bearer rply_<jouw_sleutel>

รับแจ้งเมื่อการประมวลผลเสร็จ

Rapportly ส่งข้อมูลอ้างอิงทางเทคนิคไปยังเซิร์ฟเวอร์ของคุณได้ จากนั้นดึงเนื้อหาด้วยสิทธิ์อ่านที่เหมาะสมโดยไม่ต้องถามความคืบหน้าตลอดเวลา

1. สร้างตัวรับ HTTPS และลงทะเบียนผ่าน POST /webhooks ด้วยสิทธิ์ webhooks:beheren ใช้คีย์ผลิตจริงเดียวกันสำหรับงานที่ต้องการรับแจ้ง
2. ตรวจลายเซ็นจากไบต์ข้อความต้นฉบับและเก็บรหัสเหตุการณ์แต่ละรหัสเพียงครั้งเดียว ยืนยันหลังบันทึกอย่างปลอดภัยพร้อมงานถัดไป การแจ้งซ้ำต้องไม่สร้างงานที่สอง
3. อ่าน GET /webhook-afleveringen และรายละเอียดการส่ง ระบบลองข้อผิดพลาดชั่วคราวซ้ำไม่เกินแปดครั้ง และขอรอบเพิ่มได้ ยอมรับแล้วหมายถึงเซิร์ฟเวอร์ของคุณรับข้อความเท่านั้น ตรวจการทำงานถัดไปในระบบคุณ

• ดาวน์โหลดคู่มือ webhook ข้อจำกัด และการกู้คืน
• ดาวน์โหลดตัวอย่าง Node.js ตรวจลายเซ็น

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

รหัสข้อผิดพลาดหมายถึงอะไร

ปกป้องคีย์และข้อมูลลูกค้า

• ใช้คีย์เฉพาะบนเซิร์ฟเวอร์ ห้ามใส่ในโค้ดเบราว์เซอร์สาธารณะ
• ใช้คีย์แยกต่อการเชื่อมต่อและเพิกถอนคีย์เก่า
• อย่าใส่คีย์ ผลลัพธ์ หรือลิงก์ชั่วคราวในบันทึกหรือแชตสาธารณะ
• เก็บข้อมูลลูกค้าที่ได้รับตามกฎการเข้าถึงของระบบคุณ