ข้ามไปยังเนื้อหาหลัก

Overview

Consentrix คือแพลตฟอร์มสำหรับจัดการความยินยอม เอกสารชุดนี้อธิบาย Consent Management Service integration API ตามที่เผยแพร่ไว้ใน OpenAPI specification ของโปรเจกต์ ซึ่งรวมเส้นทางภายใต้ /api/v1 สำหรับดึงเนื้อหา consent template บันทึกการตัดสินใจของผู้ใช้ปลายทาง และ /api/health สำหรับตรวจสอบสถานะระบบ

Who should use this API​

  • System integrators ที่ต้องฝังการเก็บ consent ลงในแอปหรือบริการต่าง ๆ เช่น mobile, web หรือ backend-for-frontend
  • Partners ที่ต้องเชื่อมระบบของตนเองกับ Consentrix ผ่าน server-to-server calls
  • Internal teams ที่สร้างหรือดูแล integration กับ shared consent service

Capabilities in this reference​

AreaWhat you can do
Healthตรวจสอบว่า service ยังทำงานอยู่ (GET /api/health)
GetConsentโหลดเวอร์ชัน published ล่าสุดของ template_code หรือเวอร์ชัน pending ล่าสุดของ customer_id + template_code ที่ระบุ
DecisionSubmit การตัดสินใจเรื่องความยินยอมของลูกค้า (given, reject หรือ withdraw) สำหรับ consent version หนึ่ง ๆ

Request URL​

แต่ละ environment จะกำหนด API origin ให้ โดยทุก operation ใช้ base path /api ที่คงที่และไม่มี deployment domain ถูก hardcode ไว้ใน specification

{API_ORIGIN}{REQUEST_PATH}

How to read this site​

ใช้กลุ่ม API Reference ใน sidebar เช่น Health, GetConsent และ Decision เพื่อดูรายละเอียดของแต่ละ operation แบบ interactive หากคุณยังต้องการข้อมูลพื้นฐาน เช่น base URL, authentication, รูปแบบ response และคำศัพท์เชิงโดเมน แนะนำให้อ่านหัวข้อใน Get Started ก่อน