Kongsi melalui

Gunakan API Customer Insights - Data

  • Artikel

Dynamics 365 Customer Insights - Data menyediakan API untuk membina aplikasi anda sendiri berdasarkan data anda dalam Wawasan Pelanggan. Butiran API ini disenaraikan pada rujukan API. Ia termasuk maklumat tambahan mengenai operasi, parameter dan respons.

Nota

Customer Insights - Data jadual juga boleh diakses menggunakan Dataverse API. Kami mengesyorkan agar anda menggunakan Dataverse API untuk menanyakan data Wawasan Pelanggan kerana ia menawarkan penapisan yang lebih luas, daya pemprosesan yang lebih besar dan latensi yang lebih rendah. Untuk maklumat lanjut, lihat Dataverse API untuk Wawasan Pelanggan.

Mula mencuba API

Pentadbir mesti mendayakan capaian API ke data anda. Setelah akses didayakan, mana-mana pengguna boleh menggunakan API dengan kunci langganan.

  1. log masuk Customer Insights - Data atau daftar untuk versi percubaan Wawasan Pelanggan.

  2. Pergi ke >Seting Keizinan dan pilih tab API .

  3. Jika akses API kepada persekitaran belum disediakan, pilih Dayakan.

    Mendayakan API mencipta kunci langganan utama dan sekunder untuk persekitaran anda yang digunakan dalam permintaan API. Untuk menjana semula kekunci, pilih Menjana semula primer atau Menjana semula sekunder pada tab API .

  4. Pilih Terokai API kami untuk mencuba API.

  5. Cari dan pilih operasi API dan pilih Cubalah.

    Bagaimana untuk menguji API.

  6. Dalam anak tetingkap sisi, setkan nilai dalam menu juntai bawah Keizinan kepada tersirat. Pengepala Authorization ditambahkan dengan token pembawa. Kunci langganan anda diisi secara automatik.

  7. Secara alternatif, tambah semua parameter pertanyaan yang perlu.

  8. Skrol ke bahagian bawah anak tetingkap sisi dan pilih Hantar.

    Respons HTTP dipaparkan di bahagian bawah anak tetingkap.

Cipta pendaftaran aplikasi baharu dalam portal Azure

Cipta pendaftaran aplikasi baharu untuk menggunakan API dalam aplikasi Azure menggunakan keizinan diwakilkan.

  1. Lengkapkan bahagian Bermula bermula.

  2. Log masuk ke portal Azure dengan akaun yang boleh mengakses data Wawasan Pelanggan.

  3. Cari dan kemudian pilih Pendaftaran apl.

  4. Pilih Pendaftaran baru, berikan nama permohonan dan pilih jenis akaun.

    Secara alternatif, tambah URL hala semula. http://localhost adalah mencukupi untuk membangunkan aplikasi pada komputer tempatan anda.

  5. Pilih Daftar.

  6. Pada pendaftaran Apl baharu anda, pergi ke keizinan API.

  7. Pilih Tambah keizinan dan pilih Wawasan Pelanggan Dynamics 365 AI for dalam anak tetingkap sisi.

  8. Untuk Jenis Keizinan, pilih Keizinan diwakilkan kemudian pilih keizinan user_impersonation .

  9. Pilih Tambah keizinan.

  10. Pilih Berikan persetujuan pentadbir untuk... untuk melengkapkan pendaftaran aplikasi.

  11. Untuk mengakses API tanpa log masuk pengguna, pergi ke Tetapkan keizinan aplikasi pelayan ke pelayan.

Anda boleh menggunakan ID Aplikasi/Pelanggan untuk pendaftaran aplikasi ini dengan Pustaka Pengesahan Microsoft (MSAL) untuk mendapatkan token pembawa untuk dihantar dengan permintaan anda kepada API.

Untuk maklumat tentang menggunakan API dalam pustaka pelanggan kami, lihat Pustaka klien Wawasan Pelanggan.

Mengesetkan keizinan aplikasi pelayan ke pelayan

Cipta pendaftaran apl yang tidak memerlukan interaksi pengguna dan boleh dijalankan pada pelayan.

  1. Pada pendaftaran Aplikasi anda dalam portal Azure, pergi ke keizinan API.

  2. Pilih Tambah keizinan.

  3. Pilih tab API yang digunakan oleh organisasi saya dan pilih Wawasan Pelanggan Dynamics 365 AI for daripada senarai.

  4. Untuk Jenis Keizinan, pilih Keizinan aplikasi kemudian pilih keizinan api.access .

  5. Pilih Tambah keizinan.

  6. Kembali ke keizinan API untuk pendaftaran apl anda.

  7. Pilih Berikan persetujuan pentadbir untuk... untuk melengkapkan pendaftaran aplikasi.

  8. Tambah nama pendaftaran aplikasi sebagai pengguna Customer Insights - Data.

    1. Buka Customer Insights - Data, pergi ke Keizinan>Tetapan dan pilih Tambah pengguna.

    2. Cari nama pendaftaran apl anda, pilih nama itu daripada hasil carian dan pilih Simpan.

Pertanyaan sampel

Untuk senarai pendek pertanyaan sampel OData untuk bekerja dengan API, lihat contoh pertanyaan OData.

Pustaka klien Customer Insights

Mari bermula menggunakan pustaka klien yang tersedia untuk Customer Insights - Data API. Semua kod sumber perpustakaan dan aplikasi sampel boleh didapati di repo GitHub.

C# NuGet

Gunakan pustaka klien C# dari.org NuGet. Pada masa ini, pakej menyasarkan rangka kerja netstandard2.0 dan netcoreapp2.0. Untuk maklumat lanjut tentang NuGet pakej, lihat Microsoft.Dynamics.CustomerInsights.Api.

Tambah pustaka klien C# untuk projek C#

  1. Dalam Visual Studio, buka NuGet Pengurus Pakej untuk projek anda.

  2. Cari Microsoft.Dynamics.CustomerInsights.Api.

  3. Pilih Pasang untuk menambah pakej pada projek.

    Sebagai alternatif, jalankan NuGet arahan ini dalam Konsol Pengurus Pakej: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Gunakan pustaka klien C#

  1. Gunakan Pustaka Pengesahan Microsoft (MSAL) untuk menggunakan AccessToken pendaftaran aplikasi Azure sedia adaanda.

  2. Selepas berjaya mengesahkan dan memperoleh token, bina yang baharu atau gunakan yang sedia ada HttpClient dengan "Kebenaran" DefaultRequestHeaders yang ditetapkan kepada Pembawa "token akses" dan set Ocp-Apim-Subscription-Key kepada kunci langganan daripada persekitaran Customer Insights - Data anda.

    Mengeset semula pengepala Keizinan apabila sesuai. Contohnya, apabila token tamat tempoh.

  3. Lulus ini HttpClient ke dalam pembinaan CustomerInsights pelanggan.

  4. Buat panggilan dengan pelanggan ke "kaedah sambungan", sebagai contoh, GetAllInstancesAsync. Jika akses kepada dasar lebih Microsoft.Rest.HttpOperationResponse disukai, gunakan "kaedah mesej http", sebagai contoh, GetAllInstancesWithHttpMessagesAsync.

  5. Respons object mungkin jenis kerana kaedah ini boleh mengembalikan berbilang jenis (contohnya,dan IList<InstanceInfo> ApiErrorResult). Untuk menyemak jenis pemulangan, gunakan objek dalam jenis respons yang ditentukan pada halaman butiran API untuk pengendalian tersebut.

    Jika maklumat lanjut mengenai permintaan diperlukan, gunakan kaedah mesej http untuk mencapai objek respons mentah.

Pakej NodeJS

Gunakan perpustakaan klien NodeJS yang tersedia melalui NPM: https://www.npmjs.com/package/@microsoft/customerinsights

Pakej Python

Gunakan perpustakaan klien Python yang tersedia melalui PyPi: https://pypi.org/project/customerinsights/