ทํางานกับข้อมูลเชิงลึกของลูกค้า - API ข้อมูล

Dynamics 365 Customer Insights - ข้อมูลมี API เพื่อสร้างแอปพลิเคชันของคุณเองโดยยึดตามข้อมูลของคุณในข้อมูลเชิงลึกของลูกค้า คุณสามารถดูรายละเอียดเกี่ยวกับ API เหล่านี้ได้ใน เอกสารอ้างอิง API ซึ่งรวมถึงข้อมูลเกี่ยวกับการดําเนินการ พารามิเตอร์ และการตอบสนอง

Note

ข้อมูลเชิงลึกของลูกค้า - ตารางข้อมูลยังสามารถเข้าถึงได้โดยใช้ API ของ Dataverse เราขอแนะนําให้คุณใช้ Dataverse API เพื่อคิวรีข้อมูลข้อมูลเชิงลึกของลูกค้า เนื่องจากมีการกรองที่ครอบคลุมมากขึ้น อัตราความเร็วที่มากขึ้น และเวลาแฝงที่ต่ํากว่า สําหรับข้อมูลเพิ่มเติม ดู Api ของ Dataverse สําหรับข้อมูลเชิงลึกของลูกค้า

เริ่มต้นใช้งาน API

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

1. ลงชื่อเข้าใช้ข้อมูลเชิงลึกของลูกค้า - ข้อมูลหรือลงทะเบียนเพื่อทดลองใช้ข้อมูลเชิงลึกของลูกค้า

2. ไปที่สิทธิ์> และเลือกแท็บ API

3. หากยังไม่ได้ตั้งค่าการเข้าถึง API ให้กับสภาพแวดล้อม ให้เลือก เปิดใช้งาน

   เมื่อคุณเปิดใช้งาน API คุณจะสร้างคีย์การสมัครสมาชิกหลักและรองสําหรับสภาพแวดล้อมของคุณซึ่งใช้ในคําขอ API หากต้องการสร้างคีย์ใหม่ ให้เลือก สร้างคีย์หลัก หรือ สร้างคีย์รองใหม่ ในแท็บ API

4. เลือก สํารวจ API ของเรา เพื่อลองใช้ API

5. ค้นหา และเลือกการดําเนินการ API และเลือก ลองใช้

   

6. ในบานหน้าต่างด้านข้าง ให้ตั้งค่าในเมนูดรอปดาวน์การตรวจสอบเป็นค่าโดยนัย ส่วนหัว Authorization จะถูกเพิ่มเข้ามาพร้อมกับโทเค็นผู้ถือ คีย์การสมัครสมาชิกของคุณจะถูกกรอกโดยอัตโนมัติ

7. หรือเพิ่มพารามิเตอร์คิวรีที่จําเป็นทั้งหมด

8. เลื่อนไปด้านล่างของบานหน้าต่างด้านข้าง และเลือกส่ง

   การตอบสนองของ HTTP จะแสดงที่ด้านล่างของบานหน้าต่าง

สร้างการลงทะเบียนแอปใหม่ในพอร์ทัล Azure

สร้างการลงทะเบียนแอปใหม่เพื่อใช้ API ในแอปพลิเคชัน Azure โดยใช้สิทธิ์ที่ได้รับมอบหมาย

1. ทํา ส่วนเริ่มต้นใช้งานให้เสร็จสมบูรณ์

2. ลงชื่อเข้าใช้ พอร์ทัล Azure ด้วยบัญชีที่สามารถเข้าถึงข้อมูล Customer Insights ได้

3. ค้นหา จากนั้นเลือก การลงทะเบียนแอป

4. เลือก ลงทะเบียนใหม่ ระบุชื่อแอปพลิเคชัน และเลือกประเภทบัญชี

   อีกทางหนึ่งคือเพิ่ม URL เปลี่ยนเส้นทาง http://localhost เพียงพอสําหรับการพัฒนาแอปพลิเคชันบนคอมพิวเตอร์ของคุณ

5. เลือก ลงทะเบียน

6. เมื่อสมัครแอปใหม่ของคุณ ให้ไปที่สิทธิ์ API

7. เลือก เพิ่มสิทธิ์ และเลือก AI ของ Dynamics 365 สําหรับ ข้อมูลเชิงลึกของลูกค้า ในบานหน้าต่างด้านข้าง

8. สําหรับ ชนิดสิทธิ์ ให้เลือก สิทธิ์ที่ได้รับมอบ จากนั้นเลือกสิทธิ์ user_impersonation

9. เลือกเพิ่มสิทธิ์

10. เลือก ให้ความยินยอมของผู้ดูแลระบบสําหรับ... เพื่อเสร็จสิ้นการลงทะเบียนแอป

11. หากต้องการเข้าถึง API โดยไม่มีผู้ใช้ลงชื่อเข้าใช้ ให้ไปที่ ตั้งค่าสิทธิ์แอปพลิเคชันของเซิร์ฟเวอร์ไปยังเซิร์ฟเวอร์

คุณสามารถใช้ APPLICATION/Client ID สําหรับการลงทะเบียนแอปนี้กับ ไลบรารีการรับรองความถูกต้องของ Microsoft (MSAL) เพื่อรับโทเค็นแบเรอร์เพื่อส่งพร้อมกับคําขอของคุณไปยัง API ได้

สําหรับข้อมูลเกี่ยวกับการใช้ API ในไลบรารีไคลเอ็นต์ของเรา ดูไลบรารีไคลเอ็นต์ Customer Insights

ตั้งค่าสิทธิ์ของแอปพลิเคชันจากเซิร์ฟเวอร์ไปยังเซิร์ฟเวอร์

สร้างการลงทะเบียนแอปที่ไม่ต้องมีปฏิสัมพันธ์จากผู้ใช้และสามารถรันบนเซิร์ฟเวอร์ได้

1. ในการลงทะเบียนแอปในพอร์ทัล Azure ให้ไปที่สิทธิ์ API

2. เลือกเพิ่มสิทธิ์

3. เลือกแท็บ API ที่องค์กรของฉันใช้ และเลือก Dynamics 365 AI สําหรับข้อมูลเชิงลึกของลูกค้า จากรายการ

4. สําหรับ ชนิดสิทธิ์ ให้เลือก สิทธิ์ของแอปพลิเคชัน จากนั้นเลือกสิทธิ์ api.access

5. เลือกเพิ่มสิทธิ์

6. กลับไปยัง สิทธิ์ API สําหรับการลงทะเบียนแอปของคุณ

7. เลือก ให้ความยินยอมของผู้ดูแลระบบสําหรับ... เพื่อเสร็จสิ้นการลงทะเบียนแอป

8. เพิ่มชื่อของการลงทะเบียนแอปเป็นผู้ใช้ในข้อมูลเชิงลึกของลูกค้า - ข้อมูล

   1. เปิดข้อมูลเชิงลึกของลูกค้า - ข้อมูล ไปที่การตั้งค่า>สิทธิ์และเลือกเพิ่มผู้ใช้

   2. ค้นหาชื่อการลงทะเบียนแอปของคุณ เลือกจากผลลัพธ์การค้นหา และเลือกบันทึก

คิวรีตัวอย่าง

สําหรับรายการสั้น ๆ ของคิวรีตัวอย่าง OData เพื่อทํางานกับ API ดูตัวอย่างคิวรี OData

ไลบรารีของไคลเอ็นต์ Customer Insights

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

C# NuGet

ใช้ไลบรารีไคลเอ็นต์ C# จาก NuGet.org ในปัจจุบัน แพคเกจกําหนดเป้าหมายเฟรมเวิร์ก netstandard2.0 และ netcoreapp2.0 สําหรับข้อมูลเพิ่มเติมเกี่ยวกับแพ็กเกจ NuGet โปรดดูที่ Microsoft.DynamicsCustomerInsights.API

เพิ่มไลบรารีไคลเอ็นต์ C# ไปยังโครงการ C#

1. ใน Visual Studio เปิด ตัวจัดการแพคเกจ NuGet สําหรับโครงการของคุณ

2. ค้นหา Microsoft.Dynamics.CustomerInsights.Api

3. เลือก ติดตั้ง เพื่อเพิ่มแพคเกจไปยังโครงการ

   หรือเรียกใช้คําสั่งนี้ใน คอนโซลตัวจัดการแพคเกจ NuGet: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

ใช้ไลบรารีไคลเอ็นต์ C#

1. ใช้ Microsoft Authentication Library (MSAL) เพื่อรับAccessTokenการลงทะเบียนโดยใช้แอป Azure ที่มีอยู่ของคุณ

2. หลังจากที่คุณยืนยันตัวตนและได้รับโทเค็นแล้ว ให้สร้าง HttpClient ใหม่หรือใช้โทเค็นที่มีอยู่แล้ว ตั้งค่า DefaultRequestHeaders "Authorization" เป็น Bearer "access token" และตั้งค่า Ocp-Apim-Subscription-Key เป็นคีย์การสมัครสมาชิกจากสภาพแวดล้อม Customer Insights - Data ของคุณ

   รีเซ็ตส่วนหัว Authorization ตามความเหมาะสม เช่น เมื่อโทเค็นหมดอายุ

3. ส่ง HttpClient นี้เข้าไปในการสร้างไคลเอนต์ CustomerInsights

4. เรียกใช้ "เมธอดส่วนขยาย" โดยใช้ไคลเอ็นต์ ตัวอย่างเช่น GetAllInstancesAsync หากคุณต้องการเข้าถึงไฟล์พื้นฐาน Microsoft.Rest.HttpOperationResponseให้ใช้ "http message methods" เช่น GetAllInstancesWithHttpMessagesAsync.

5. การตอบสนองอาจเป็น object ชนิดเนื่องจากเมธอด สามารถส่งกลับได้หลายชนิด (ตัวอย่างเช่น IList<InstanceInfo> และ ApiErrorResult) หากต้องการตรวจสอบชนิดผลลัพธ์ ให้ใช้ออบเจ็กต์ ในชนิดการตอบสนองที่ระบุ ในหน้ารายละเอียด API สําหรับการดําเนินการนั้น

   หากคุณต้องการข้อมูลเพิ่มเติมเกี่ยวกับคําขอ ให้ใช้ เมธอด http message เพื่อเข้าถึงวัตถุ raw response

แพ็กเกจ Node.js

ใช้ไลบรารีไคลเอนต์ Node.js ที่มีให้ผ่าน NPM: https://www.npmjs.com/package/@microsoft/customerinsights

แพ็คเกจ Python

ใช้ไลบรารีไคลเอ็นต์ Python ที่พร้อมใช้งานผ่าน PyPi: https://pypi.org/project/customerinsights/