Membuat dan mengelola pengiriman

  • Artikel

Gunakan API pengiriman Microsoft Store untuk mengkueri dan membuat pengiriman secara terprogram untuk aplikasi, add-on, dan penerbangan paket untuk akun Pusat Mitra organisasi Anda atau Anda. API ini berguna jika akun Anda mengelola banyak aplikasi atau add-on, dan Anda ingin mengotomatiskan dan mengoptimalkan proses pengiriman untuk aset ini. API ini menggunakan Azure Active Directory (Azure AD) untuk mengautentikasi panggilan dari aplikasi atau layanan Anda.

Langkah-langkah berikut menjelaskan proses end-to-end menggunakan MICROSOFT Store submission API:

  1. Pastikan Anda telah menyelesaikan semua prasyarat.
  2. Sebelum Anda memanggil metode di MICROSOFT Store submission API, dapatkan token akses Azure AD. Setelah mendapatkan token, Anda memiliki waktu 60 menit untuk menggunakan token ini dalam panggilan ke API pengiriman Microsoft Store sebelum token kedaluwarsa. Setelah token kedaluwarsa, Anda dapat membuat token baru.
  3. Hubungi API pengiriman Microsoft Store.

Penting

Jika Anda menggunakan API ini untuk membuat pengiriman untuk aplikasi, penerbangan paket, atau add-on, pastikan untuk membuat perubahan lebih lanjut pada pengiriman hanya dengan menggunakan API, bukan di Pusat Mitra. Jika Anda menggunakan Pusat Mitra untuk mengubah pengiriman yang awalnya Anda buat dengan menggunakan API, Anda tidak akan lagi dapat mengubah atau menerapkan pengiriman tersebut dengan menggunakan API. Dalam beberapa kasus, pengiriman dapat dibiarkan dalam status kesalahan di mana tidak dapat dilanjutkan dalam proses pengiriman. Jika ini terjadi, Anda harus menghapus pengiriman dan membuat pengiriman baru.

Penting

Anda tidak dapat menggunakan API ini untuk menerbitkan pengiriman untuk pembelian volume melalui Microsoft Store untuk Bisnis dan Microsoft Store untuk Pendidikan atau menerbitkan pengiriman untuk aplikasi LOB langsung ke perusahaan. Untuk kedua skenario ini, Anda harus menggunakan terbitkan pengiriman di Pusat Mitra.

Catatan

API ini tidak dapat digunakan dengan aplikasi atau add-on yang menggunakan pembaruan aplikasi wajib dan add-on yang dapat dikonsumsi yang dikelola Store. Jika Anda menggunakan API pengiriman Microsoft Store dengan aplikasi atau add-on yang menggunakan salah satu fitur ini, API akan mengembalikan kode kesalahan 409. Dalam hal ini, Anda harus menggunakan Pusat Mitra untuk mengelola pengiriman untuk aplikasi atau add-on.

Langkah 1: Selesaikan prasyarat untuk menggunakan API pengiriman Microsoft Store

Sebelum Anda mulai menulis kode untuk memanggil API pengiriman Microsoft Store, pastikan Anda telah menyelesaikan prasyarat berikut.

  • Anda (atau organisasi Anda) harus memiliki direktori Azure AD dan Anda harus memiliki izin Administrator global untuk direktori tersebut. Jika sudah menggunakan Microsoft 365 atau layanan bisnis lainnya dari Microsoft, Anda sudah memiliki direktori Azure AD. Jika tidak, Anda dapat membuat Azure AD baru di Pusat Mitra tanpa biaya tambahan.

  • Anda harus mengaitkan aplikasi Azure AD dengan akun Pusat Mitra dan mendapatkan ID penyewa, ID klien, dan kunci Anda. Anda memerlukan nilai-nilai ini untuk mendapatkan token akses Azure AD, yang akan Anda gunakan dalam panggilan ke API pengajuan Microsoft Store.

  • Siapkan aplikasi Anda untuk digunakan dengan API pengiriman Microsoft Store:

    • Jika aplikasi Anda belum ada di Pusat Mitra, Anda harus membuat aplikasi dengan menyimpan namanya di Pusat Mitra. Anda tidak dapat menggunakan API pengiriman Microsoft Store untuk membuat aplikasi di Pusat Mitra; Anda harus bekerja di Pusat Mitra untuk membuatnya, lalu setelah itu Anda dapat menggunakan API untuk mengakses aplikasi dan secara terprogram membuat pengiriman untuk itu. Namun, Anda dapat menggunakan API untuk membuat add-on dan penerbangan paket secara terprogram sebelum membuat pengiriman untuk mereka.

    • Sebelum dapat membuat pengiriman untuk aplikasi tertentu menggunakan API ini, Anda harus terlebih dahulu membuat satu pengiriman untuk aplikasi di Pusat Mitra, termasuk menjawab kuesioner peringkat usia . Setelah melakukan ini, Anda akan dapat membuat pengiriman baru secara terprogram untuk aplikasi ini menggunakan API. Anda tidak perlu membuat pengiriman add-on atau pengiriman penerbangan paket sebelum menggunakan API untuk jenis pengiriman tersebut.

    • Jika Anda membuat atau memperbarui pengiriman aplikasi dan perlu menyertakan paket aplikasi, siapkan paket aplikasi.

    • Jika Anda membuat atau memperbarui pengiriman aplikasi dan perlu menyertakan cuplikan layar atau gambar untuk daftar Toko, siapkan cuplikan layar dan gambar aplikasi.

    • Jika Anda membuat atau memperbarui pengiriman add-on dan Anda perlu menyertakan ikon, siapkan ikon .

Cara mengaitkan aplikasi Azure AD dengan akun Pusat Mitra Anda

Sebelum dapat menggunakan API pengiriman Microsoft Store, Anda harus mengaitkan aplikasi Azure AD dengan akun Pusat Mitra Anda, mengambil ID penyewa dan ID klien untuk aplikasi dan membuat kunci. Aplikasi Azure AD mewakili aplikasi atau layanan tempat Anda ingin memanggil API pengiriman Microsoft Store. Anda memerlukan ID penyewa, ID klien, dan kunci untuk mendapatkan token akses Azure AD yang Anda berikan ke API.

Catatan

Anda hanya perlu melakukan tugas ini satu kali. Setelah Anda memiliki ID penyewa, ID klien, dan kunci, Anda dapat menggunakannya kembali kapan saja Anda perlu untuk membuat token akses Azure AD baru.

  1. Di Pusat Mitra, kaitkan akun Pusat Mitra organisasi Anda dengan direktori Azure AD organisasi Anda.

  2. Berikutnya, dari halamanPengguna di bagian Pengaturan akun di bagian Pusat Mitra, tambahkan aplikasi Azure AD yang mewakili aplikasi atau layanan yang akan Anda gunakan untuk mengakses pengajuan untuk akun Pusat Mitra Anda. Pastikan Anda menetapkan aplikasi ini sebagai peranManager. Jika aplikasi belum ada di direktori Azure AD, Anda dapat membuat aplikasi Azure AD baru di Pusat Mitra.

  3. Kembali ke halaman Pengguna, klik nama aplikasi Azure AD Anda untuk masuk ke pengaturan aplikasi, dan salin nilai ID Penyewa dan ID Klien.

  4. Klik Tambahkan kunci baru. Pada layar berikut, salin ke bawah nilai Kunci. Anda tidak akan bisa mengakses info ini lagi setelah meninggalkan halaman ini. Untuk informasi selengkapnya, lihat Mengelola kunci untuk aplikasi Azure AD.

Langkah 2 : Mendapatkan token akses Azure AD

Sebelum memanggil salah satu metode di API pengiriman Microsoft Store, Anda harus terlebih dahulu mendapatkan token akses Azure AD yang Anda berikan ke header Otorisasi dari setiap metode di API. Setelah mendapatkan token akses, Anda memiliki waktu 60 menit untuk menggunakannya sebelum masa berlakunya habis. Setelah token kedaluwarsa, Anda dapat merefresh token sehingga Anda dapat terus menggunakannya dalam panggilan lebih lanjut ke API.

Untuk mendapatkan token akses, ikuti instruksi dalam Panggilan Layanan ke Layanan Menggunakan Kredensial Klien untuk mengirim HTTP POST ke https://login.microsoftonline.com/<tenant_id>/oauth2/token titik akhir. Berikut adalah contoh permintaan.

POST https://login.microsoftonline.com/<tenant_id>/oauth2/token HTTP/1.1
Host: login.microsoftonline.com
Content-Type: application/x-www-form-urlencoded; charset=utf-8

grant_type=client_credentials
&client_id=<your_client_id>
&client_secret=<your_client_secret>
&resource=https://manage.devcenter.microsoft.com

Untuk nilai tenant_id di POST URI dan parameter client_id dan client_secret , tentukan ID penyewa, ID klien, dan kunci untuk aplikasi yang Anda ambil dari Pusat Mitra di bagian sebelumnya. Untuk parameter sumber daya, Anda harus menentukan https://manage.devcenter.microsoft.com.

Setelah token akses Anda kedaluwarsa, Anda dapat mengambil yang baru dengan melakukan panggilan HTTP yang sama lagi.

Untuk contoh yang menunjukkan cara mendapatkan token akses dengan menggunakan kode C#, Java, atau Python, lihat contoh kode API pengiriman Microsoft Store.

Langkah 3: Gunakan API pengajuan Microsoft Store

Setelah memiliki token akses Azure AD, Anda dapat memanggil metode di API pengiriman Microsoft Store. API mencakup banyak metode yang dikelompokkan ke dalam skenario untuk aplikasi, add-on, dan penerbangan paket. Untuk membuat atau memperbarui pengiriman, Anda biasanya memanggil beberapa metode di API pengiriman Microsoft Store dalam urutan tertentu. Untuk informasi tentang setiap skenario dan sintaks setiap metode, lihat artikel dalam tabel berikut ini.

Catatan

Setelah mendapatkan token akses, Anda memiliki waktu 60 menit untuk memanggil metode di API pengiriman Microsoft Store sebelum token kedaluwarsa.

Skenario Deskripsi
Aplikasi Ambil data untuk semua aplikasi yang terdaftar ke akun Pusat Mitra Anda dan buat pengiriman untuk aplikasi. Untuk informasi selengkapnya tentang metode ini, lihat artikel berikut ini:
Add-on Dapatkan, buat, atau hapus add-on untuk aplikasi Anda, lalu dapatkan, buat, atau hapus pengiriman untuk add-on. Untuk informasi selengkapnya tentang metode ini, lihat artikel berikut ini:
Penerbangan paket Dapatkan, buat, atau hapus penerbangan paket untuk aplikasi Anda, lalu dapatkan, buat, atau hapus pengiriman untuk penerbangan paket. Untuk informasi selengkapnya tentang metode ini, lihat artikel berikut ini:

Contoh kode

Artikel berikut ini menyediakan contoh kode terperinci yang menunjukkan cara menggunakan API pengiriman Microsoft Store dalam beberapa bahasa pemrograman yang berbeda:

Modul StoreBroker PowerShell

Sebagai alternatif untuk memanggil API pengiriman Microsoft Store secara langsung, kami juga menyediakan modul PowerShell sumber terbuka yang mengimplementasikan antarmuka baris perintah di atas API. Modul ini disebut StoreBroker. Anda dapat menggunakan modul ini untuk mengelola pengiriman aplikasi, penerbangan, dan add-on dari baris perintah alih-alih memanggil API pengiriman Microsoft Store secara langsung, atau Anda cukup menelusuri sumber untuk melihat contoh selengkapnya tentang cara memanggil API ini. Modul StoreBroker secara aktif digunakan dalam Microsoft sebagai cara utama bahwa banyak aplikasi pihak pertama dikirimkan ke Store.

Untuk informasi selengkapnya, lihat halaman StoreBroker kami di GitHub.

Pemecahan Masalah

Masalah Resolusi
Setelah memanggil API pengiriman Microsoft Store dari PowerShell, data respons untuk API rusak jika Anda mengonversinya dari format JSON ke objek PowerShell menggunakan cmdlet ConvertFrom-Json lalu kembali ke format JSON menggunakan cmdlet ConvertTo-Json . Secara default, parameter -Depth untuk cmdlet ConvertTo-Json diatur ke 2 tingkat objek, yang terlalu dangkal untuk sebagian besar objek JSON yang dikembalikan oleh API pengiriman Microsoft Store. Saat Anda memanggil cmdlet ConvertTo-Json , atur parameter -Depth ke angka yang lebih besar, seperti 20.

Bantuan tambahan

Jika Anda memiliki pertanyaan tentang API pengiriman Microsoft Store atau memerlukan bantuan untuk mengelola pengiriman Anda dengan API ini, gunakan sumber daya berikut:

  • Ajukan pertanyaan Anda di forum kami.
  • Kunjungi halaman dukungan kami dan minta salah satu opsi dukungan yang dibantu untuk Pusat Mitra. Jika Anda diminta untuk memilih jenis dan kategori masalah, pilih Pengiriman dan sertifikasi aplikasi dan Mengirimkan aplikasi.