Referensi API Portal Mitra Cloud

  • Artikel

Catatan

API Portal Mitra Cloud terintegrasi dengan dan akan terus bekerja di Pusat Mitra. Transisi memperkenalkan perubahan kecil. Tinjau API Perubahan pada CPP yang tercantum dalam dokumen ini untuk memastikan kode Anda terus berfungsi setelah beralih ke Pusat Mitra. API CPP hanya boleh digunakan untuk produk yang sudah terintegrasi sebelum transisi ke Pusat Mitra. Produk baru harus menggunakan API pengiriman Pusat Mitra.

API REST Portal Mitra Cloud memungkinkan pengambilan dan manipulasi beban kerja, penawaran, dan profil penerbit yang terprogram. API menggunakan kontrol akses berbasis peran Azure (Azure RBAC) untuk memberlakukan izin yang benar pada waktu pemrosesan.

Referensi ini menyediakan detail teknis untuk API REST Portal Mitra Cloud. Sampel muatan dalam dokumen ini hanya untuk referensi dan dapat berubah saat fungsionalitas baru ditambahkan.

Prasyarat dan pertimbangan

Sebelum menggunakan API, Anda harus meninjau:

  • Artikel Prasyarat untuk mempelajari cara menambahkan perwakilan layanan ke akun Anda, dan mendapatkan token akses Microsoft Entra untuk autentikasi.
  • Dua strategi kontrol konkurensi tersedia untuk memanggil API ini.
  • Pertimbangan API lainnya, seperti penerapan versi dan penanganan kesalahan.

Perubahan pada API CPP setelah migrasi ke Pusat Mitra

API Ubah deskripsi Dampak
POST Publish, GoLive, Cancel Untuk penawaran yang dimigrasikan, header respons memiliki format yang berbeda tetapi terus bekerja dengan cara yang sama, menunjukkan jalur relatif untuk mengambil status operasi. Saat mengirim salah satu permintaan POST yang sesuai untuk penawaran, header Lokasi memiliki salah satu dari dua format tergantung pada status migrasi penawaran:
  • Penawaran yang tidak dimigrasikan
    /api/operations/{PublisherId}${offerId}$2$preview?api-version=2017-10-31
  • Penawaran yang dimigrasikan
    /api/publishers/{PublisherId}/offers/{offereId}/operations/408a4835-0000-1000-0000-000000000000?api-version=2017-10-31
DAPATKAN Operasi Untuk penawaran yang sebelumnya mendukung bidang 'email notifikasi' dalam respons, bidang ini akan ditolak dan tidak lagi dikembalikan untuk penawaran yang dimigrasikan. Untuk penawaran yang dimigrasikan, kami tidak akan lagi mengirim pemberitahuan ke daftar email yang ditentukan dalam permintaan. Sebagai gantinya, layanan API selaras dengan proses email pemberitahuan di Pusat Mitra untuk mengirim email. Secara khusus, pemberitahuan kemajuan operasi akan dikirim ke alamat email yang diatur di bagian info kontak Penjual di pengaturan akun Anda di Pusat Mitra.

Tinjau alamat email yang diatur di bagian Info kontak Penjual di pengaturan Akun Anda di Pusat Mitra untuk memastikan email yang benar disediakan untuk pemberitahuan.

Tugas umum

Referensi ini merinci API untuk melakukan tugas umum berikut.

Penawaran

Operasional

Memublikasikan aplikasi

Tugas Lain

Pemecahan Masalah

Versi dan pembaruan API

Perbarui Apa yang telah berubah?
12-2022 API publik CPP (versi 2017-10-31) sekarang diperbarui untuk menangkap clientId dan clientSecret untuk konektor Marketo saat mengonfigurasi prospek pelanggan. Selama konfigurasi prospek, Anda tidak perlu menyediakan bidang serverId ke depannya. Pembaruan ke API ini tidak melibatkan pembaruan versi atau perubahan yang melanggar.