שתף באמצעות

עבודה עם ממשקי API של Customer Insights - Data

  • מאמר

Dynamics 365 Customer Insights - Data מספק ממשקי API לבניית יישומים משלך בהתבסס על הנתונים שלך ב- Customer Insights. פרטים על ממשקי API אלה מפורטים בהפניה ל-API. הם כוללים מידע נוסף על פעולות, פרמטרים ותגובות.

הערה

ניתן לגשת לטבלאות Customer Insights - Data גם באמצעות ממשקי API של Dataverse. אנו ממליצים להשתמש בממשקי API של Dataverse כדי לבצע שאילתות על נתוני Customer Insights מכיוון שהם מציעים סינון נרחב יותר, תפוקה גדולה יותר והשהיה נמוכה יותר. למידע נוסף, ראה ‏‫ממשקי API של Dataverse עבור Customer Insights.

התחל לנסות את ממשקי ה-API

מנהל מערכת חייב לאפשר גישת API לנתונים שלך. לאחר הפעלת הגישה, כל משתמש יכול להשתמש ב- API עם מפתח המנוי.

  1. היכנס ל- Customer Insights - Data או הירשם לגרסת ניסיון של Customer Insights.

  2. עבור אל הגדרות>הרשאות, ולאחר מכן בחר בכרטיסיה ממשקי API.

  3. אם לא הוגדרה גישת API לסביבה, בחר הפוך לזמין.

    הפעלת ממשקי ה- API יוצרת מפתח מנוי ראשי ומשני עבור הסביבה שלך המשמש בבקשות ה- API. כדי ליצור מחדש את המפתחות, בחר באפשות יצירה מחדש של המפתח הראשי או יצירה מחדש של המפתח המשני בכרטיסיה API.

  4. בחר סקור את ממשקי ה- API כדי לנסות אותם.

  5. חפש ובחר פעולת API ובחר נסה זאת.

    כיצד לבדוק את ממשקי ה- API.

  6. בחלונית הצד, הגדר את הערך בתפריט הנפתח הרשאה למשתמע. הכותרת Authorization מתווספת עם אסימון נושא. מפתח המנוי שלך מאוכלס אוטומטית.

  7. לחלופין, הוסף את כל פרמטרי השאילתה הדרושים.

  8. גלול לתחתית החלונית הצדדית ובחר שלח.

    תגובת ה-HTTP מוצגת בתחתית החלונית.

יצירת רישום יישום חדש בפורטל Azure

צור רישום אפליקציה חדש כדי להשתמש בממשקי ה-API ביישום Azure באמצעות הרשאות מוקצות.

  1. השלם את סעיף תחילת העבודה.

  2. היכנס אל פורטל Azure עם החשבון שיכול לגשת לנתוני Customer Insights.

  3. חפש ולאחר מכן בחר רישומי אפליקציה.

  4. בחר רישום חדש, ספק שם יישום ובחר את סוג החשבון.

    לבחירתך, הוסף כתובת URL של ניתוב מחדש. http://localhost מספיק לפיתוח יישום במחשב המקומי שלך.

  5. בחר הירשם.

  6. ברישום היישום החדש שלך, עבור אל הרשאות API.

  7. בחר הוסף הרשאה ובחר Dynamics 365 AI for Customer Insights בחלונית הצד.

  8. עבור סוג הרשאה, בחר הרשאות שהוקצו ואז בחר את הרשאת התחזות למשתמש.

  9. בחר הוסף הרשאות.

  10. בחר הענק הסכמת מנהל עבור... כדי להשלים את רישום היישום.

  11. כדי לגשת ל- API בלי שמשתמש יתחבר, עבור אל הרשאות אפליקציה משרת לשרת.

באפשרותך להשתמש במזהה היישום/לקוח עבור רישום יישום זה עם Microsoft Authentication Library‏ (MSAL) כדי להשיג אסימון נושא לשליחה עם הבקשה שלך ל- API.

למידע על השימוש בממשקי ה- API בספריות הלקוחות שלנו, ראה ספריות לקוחות של Customer Insights.

הגדר הרשאות אפליקציה של שרת לשרת

צור רישום אפליקציה שאינה זקוקה לאינטראקציה של המשתמש וניתן להפעיל אותה על שרת.

  1. ברישום היישום שלך בפורטל Azure, עבור אל הרשאות API.

  2. בחר הוסף הרשאה.

  3. בחר את הכרטיסיה ממשקי API שהארגון שלי משתמש בהם ובחר Dynamics 365 AI for Customer Insights מתוך הרשימה.

  4. עבור סוג הרשאה, בחר הרשאות של יישום ואז בחר את הרשאת api.access.

  5. בחר הוסף הרשאות.

  6. חזור אל הרשאות API עבור רישום היישום שלך.

  7. בחר הענק הסכמת מנהל עבור... כדי להשלים את רישום היישום.

  8. הוסף את שם רישום האפליקציה כמשתמש ב- Customer Insights - Data.

    1. פתח את Customer Insights - Data, עבור אל הגדרות>הרשאות ובחר הוסף משתמשים.

    2. חפש את שם רישום היישום שלך, בחר בו מתוך תוצאות החיפוש ובחר שמור.

שאילתות לדוגמה

לרשימה קצרה של שאילתות לדוגמה של OData לעבודה עם ממשקי ה-API, ראה דוגמאות לשאילתות OData.

ספריות לקוחות של Customer Insights

התחל להשתמש בספריות לקוח הזמינות עבור ממשקי API של Customer Insights - Data. ניתן למצוא את כל קוד המקור של הספריה והיישומים לדוגמה במאגר GitHub.

C# NuGet

השתמש בספריות לקוח של C# מ-NuGet‏.org. נכון לעכשיו, חבילה זו מיועדת למסגרות netstandard2.0 ו- netcoreapp2.0. למידע נוסף על חבילת NuGet, ראהMicrosoft.Dynamics.CustomerInsights.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 "אימות" שמוגדר ל- "אסימון גישה" של נושא ו- Ocp-Apim-Subscription-Key שמוגדרת למפתח מינוי מסביבת Customer Insights - Data שלך.

    אפס את הכותרת הרשאה במועד המתאים. לדוגמה, כאשר פג תוקף האסימון.

  3. העבר HttpClient זה אל המבנה של הלקוח CustomerInsights.

  4. בצע שיחות עם הלקוח ל"שיטות ההרחבה", למשל, GetAllInstancesAsync. אם עדיפה לך גישה אל Microsoft.Rest.HttpOperationResponse הבסיסי, השתמש ב"שיטות הודעת http", לדוגמה GetAllInstancesWithHttpMessagesAsync.

  5. התגובה תהיה ככל הנראה מסוג object, כי פעולת השירות יכולה להחזיר סוגים מרובים (לדוגמה, IList<InstanceInfo> ו-ApiErrorResult). כדי לבדוק את סוג ההחזרה, השתמש באובייקטים בסוגי התגובה שצוינו בדף פרטי API לאותה פעולה.

    אם יש צורך במידע נוסף על הבקשה, השתמש בפעולות שירות של הודעת https כדי לגשת לאובייקט התגובה הגולמי.

חבילת NodeJS

השתמש בספריות הלקוח של NodeJS הזמינות דרך NPM: https://www.npmjs.com/package/@microsoft/customerinsights

חבילת Python

השתמש בספריות הלקוח של Python הזמינות דרך PyPi: https://pypi.org/project/customerinsights/