ภาพรวมของ API

CitrusAd ทํางานอย่างไร

CitrusAd API ถูกจัดระเบียบรอบๆ REST API มี URL เชิงทรัพยากรที่คาดการณ์ได้ และใช้รหัสตอบกลับ HTTP เพื่อระบุข้อผิดพลาดของ API API ใช้คุณสมบัติ HTTP ในตัวรวมถึงการตรวจสอบสิทธิ์ HTTP และกริยา HTTP ซึ่งไคลเอนต์ HTTP นอกชั้นวางเข้าใจ

การตรวจสอบสิทธิ์กับ CitrusAd API ถูกจัดการโดยใช้คีย์ API คีย์ API จะใช้ระหว่างการสื่อสารระหว่างแบ็กเอนด์ของคุณและ CitrusAd API

CitrusAd API รองรับการอัปโหลดผลิตภัณฑ์ แคตตาล็อก ลูกค้า และข้อมูลคำสั่งซื้อ ซึ่งใช้ในการสร้างโฆษณา คุณสามารถใช้ CitrusAd API เพื่อขอโฆษณาและรายงานการโต้ตอบกับโฆษณาเหล่านั้น

เอ็นพอยต์ CitrusAd

CitrusAd ใช้เอ็นพอยต์ต่างๆ ในการซิงค์ข้อมูลและสร้างโฆษณา ข้อมูลสรุปโดยย่อมีให้ด้านล่าง:

เอ็นพอยต์การใช้งานคำอธิบาย
catalogsการซิงค์แค็ตตาล็อกผ่าน APIใช้ในการสร้างแคตตาล็อกผ่าน API ผู้จัดการบัญชีด้านเทคนิคของคุณสามารถจัดการเนมสเปซแค็ตตาล็อกเดียวให้คุณได้
catalog-productsการซิงค์ผลิตภัณฑ์ผ่าน APIใช้เพื่อสร้างและอัปเดตข้อมูลผลิตภัณฑ์ภายในแค็ตตาล็อก
customersการซิงค์ข้อมูลลูกค้าผ่าน APIใช้เพื่อสร้างและอัปเดตข้อมูลลูกค้าภายในแค็ตตาล็อก
ordersกำลังซิงค์ข้อมูลคำสั่งซื้อผ่าน APIใช้เพื่อส่งข้อมูลคำสั่งซื้อไปยัง CitrusAd
/resource/การรายงานการคลิกและการแสดงผล การซิงค์ข้อมูลคำสั่งซื้อผ่าน APIใช้เพื่อรายงานการคลิกและการแสดงผล ตลอดจนคำสั่งซื้อหากรายงานผ่านส่วนหน้า
/ads/generateการสร้างโฆษณาใช้ในการสร้างโฆษณาผลิตภัณฑ์และโฆษณาแบนเนอร์
/ads/bannerxการสร้างโฆษณาใช้เพื่อสร้างโฆษณาแบนเนอร์ x

📘

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

ประเภทเนื้อหาและเพย์โหลด

เพย์โหลดข้อมูลอยู่ในรูปแบบ JSON AD_ID Content-Type สําหรับเอนพอยต์เหล่านี้คือ application/jsonซึ่งควรส่งผ่านเป็นส่วนหัวในคำขอของคุณดังนี้:

-H "Content-Type: application/json" \

คําขอตรวจสอบสิทธิ์

การรับรองความถูกต้องพื้นฐาน

ทรัพยากรการรวมทั้งหมดใช้การรับรองความถูกต้องพื้นฐานซึ่งควรส่งผ่านเป็นส่วนหัวด้วยคีย์ API ของคุณดังนี้:

-H "Authorization: Basic 4ww25f70-b52s-40de-8f29-07b139b5cdc8" \

คีย์ API ของคุณสามารถเข้าถึงได้ในส่วนการตั้งค่าการรวมของทีมผู้ค้าปลีก คุณจะต้องใช้คีย์ API ลับเท่านั้น

การรับรองความถูกต้อง OAuth 2.0

เอ็นพอยต์การสร้างโฆษณาของ CitrusAd ยังเข้ากันได้กับ OAuth2.0 ตรวจสอบการตรวจสอบสิทธิ์ OAuth 2.0 สำหรับข้อมูลเพิ่มเติม

URL พื้นฐาน

CitrusAd ใช้ URL พื้นฐานที่แตกต่างกันสำหรับสภาพแวดล้อมการสร้างเว็บจำลองและการผลิต

📘

หากต้องการรับ URL ฐานการสร้างเว็บจำลอง โปรดติดต่อ CitrusAd เมื่อการผสานรวมของคุณอยู่ในระหว่างดำเนินการ เราจะจัดเตรียม URL ฐานการผลิตให้คุณ