Bagikan melalui

Menggunakan API Customer Insights - Data

  • Artikel

Dynamics 365 Customer Insights - Data menyediakan API untuk membangun aplikasi Anda sendiri berdasarkan data Anda di Customer Insights. Detail API ini tercantum pada referensi API. Mereka mencakup informasi tambahan tentang operasi, parameter, dan respons.

Catatan

Customer Insights - Data tabel juga dapat diakses menggunakan Dataverse API. Sebaiknya gunakan Dataverse API untuk mengkueri data Customer Insights karena API menawarkan pemfilteran yang lebih luas, throughput yang lebih besar, dan latensi yang lebih rendah. Untuk informasi selengkapnya, lihat Dataverse API untuk Customer Insights.

Mulai mencoba API

Admin harus mengaktifkan akses API ke data Anda. Setelah akses diaktifkan, setiap pengguna dapat menggunakan API dengan kunci langganan.

  1. masuk atau Customer Insights - Data daftar untuk versi uji coba Customer Insights.

  2. Buka Izin Pengaturan> dan pilih tab API .

  3. Jika akses API ke lingkungan belum disiapkan, pilih Aktifkan.

    Mengaktifkan API akan membuat kunci langganan primer dan sekunder untuk lingkungan Anda yang digunakan dalam permintaan API. Untuk meregenerasi kunci, pilih Regenerasi primer atau Regenerasi sekunder pada tab API .

  4. Pilih Jelajahi API kami untuk mencoba API.

  5. Cari dan pilih operasi API dan pilih Coba.

    Cara menguji API.

  6. Di panel samping, atur nilai di menu dropdown Otorisasi ke implisit. Header Authorization ditambahkan dengan token pembawa. Kunci langganan Anda terisi secara otomatis.

  7. Atau, Tambahkan semua parameter kueri yang diperlukan.

  8. Gulir ke bagian bawah panel samping dan pilih Kirim.

    Respons HTTP ditampilkan di bagian bawah panel.

Buat pendaftaran Aplikasi baru di portal Azure

Buat pendaftaran aplikasi baru untuk menggunakan API dalam aplikasi Azure menggunakan izin yang didelegasikan.

  1. Selesaikan bagian Memulai.

  2. Masuk ke portal Microsoft Azure dengan akun yang dapat mengakses data Customer Insights.

  3. Cari lalu pilih Pendaftaran aplikasi.

  4. Pilih Pendaftaran baru, berikan nama aplikasi dan pilih jenis akun.

    Atau, tambahkan URL pengalihan. http://localhost cukup untuk mengembangkan aplikasi di komputer lokal Anda.

  5. Pilih Daftarkan.

  6. Pada pendaftaran Aplikasi baru Anda, buka izin API.

  7. Pilih Tambahkan izin dan pilih Dynamics 365 AI for Customer Insights di panel samping.

  8. Untuk Jenis izin, pilih Izin yang didelegasikan lalu pilih izin user_impersonation .

  9. Pilih Tambahkan izin.

  10. Pilih Berikan persetujuan admin untuk... untuk menyelesaikan pendaftaran aplikasi.

  11. Untuk mengakses API tanpa pengguna masuk, buka Mengatur izin aplikasi server-ke-server.

Anda dapat menggunakan ID Aplikasi/Klien untuk pendaftaran aplikasi ini dengan Microsoft Authentication Library (MSAL) untuk mendapatkan token pembawa untuk dikirim bersama permintaan Anda ke API.

Untuk informasi tentang penggunaan API di pustaka klien kami, lihat pustaka klien Customer Insights.

Mengatur izin aplikasi server-ke-server

Buat pendaftaran aplikasi yang tidak memerlukan interaksi pengguna dan dapat dijalankan di server.

  1. Pada pendaftaran Aplikasi Anda di portal Microsoft Azure, buka izin API.

  2. Pilih Tambahkan izin.

  3. Pilih tab API yang digunakan organisasi saya dan pilih Dynamics 365 AI for Customer Insights dari daftar.

  4. Untuk Jenis izin, pilih Izin aplikasi lalu pilih izin api.access .

  5. Pilih Tambahkan izin.

  6. Kembali ke izin API untuk pendaftaran aplikasi Anda.

  7. Pilih Berikan persetujuan admin untuk... untuk menyelesaikan pendaftaran aplikasi.

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

    1. Buka Customer Insights - Data, buka Izin Pengaturan> dan pilih Tambahkan pengguna.

    2. Cari nama pendaftaran aplikasi Anda, pilih dari hasil pencarian, dan pilih Simpan.

Contoh kueri

Untuk daftar singkat kueri sampel OData agar berfungsi dengan API, lihat Contoh kueri OData.

Pustaka klien Customer Insights

Mulai menggunakan pustaka klien yang Customer Insights - Data tersedia untuk API. Semua kode sumber pustaka dan aplikasi sampel dapat ditemukan di repositori GitHub.

C# NuGet

Gunakan pustaka klien C# from.org NuGet. Saat ini, paket menargetkan kerangka kerja netstandard2.0 dan netcoreapp2.0. Untuk informasi selengkapnya tentang NuGet paket, lihat Microsoft.Dynamics.CustomerInsights.Api.

Tambahkan pustaka klien C# ke proyek C#

  1. Dalam Visual Studio, buka NuGet Manajer Paket untuk proyek Anda.

  2. Cari Microsoft.Dynamics.CustomerInsights.Api.

  3. Pilih Instal untuk menambahkan paket ke proyek.

    Atau, jalankan perintah ini di NuGet Konsol Manajer Paket: Install-Package -Id Microsoft.Dynamics.CustomerInsights.Api -Source nuget.org -ProjectName <project name> [-Version <version>]

Gunakan pustaka klien C#

  1. Gunakan Microsoft Authentication Library (MSAL) untuk menggunakan pendaftaran AccessToken aplikasi Azure yang sudah ada.

  2. Setelah berhasil mengautentikasi dan memperoleh token, buat yang baru atau gunakan yang sudah ada HttpClient dengan DefaultRequestHeaders "Otorisasi" diatur ke Pembawa "token akses" dan Ocp-Apim-Subscription-Key diatur ke kunci langganan dari lingkungan Customer Insights - Data Anda.

    Setel ulang header Otorisasi jika perlu. Misalnya, saat token kedaluwarsa.

  3. Lewati ini HttpClient ke dalam konstruksi CustomerInsights klien.

  4. Lakukan panggilan dengan klien ke "metode ekstensi", misalnya, GetAllInstancesAsync. Jika akses ke underlying Microsoft.Rest.HttpOperationResponse lebih disukai, gunakan "metode pesan http", misalnya, GetAllInstancesWithHttpMessagesAsync.

  5. Responsnya kemungkinan object tipe karena metode dapat mengembalikan beberapa tipe (misalnya, IList<InstanceInfo> dan ApiErrorResult). Untuk memeriksa jenis pengembalian, gunakan objek dalam jenis respons yang ditentukan pada halaman detail API untuk operasi tersebut.

    Jika informasi lebih lanjut tentang permintaan diperlukan, gunakan metode pesan http untuk mengakses objek respons mentah.

Paket NodeJS

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

Paket Python

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