Bagikan melalui

API dasbor perangkat keras

  • Artikel

Gunakan API Perangkat Keras Microsoft untuk mengkueri dan membuat pengiriman produk perangkat keras secara terprogram dalam akun Pusat Mitra organisasi Anda. API ini berguna jika akun Anda mengelola banyak produk, dan Anda ingin mengotomatiskan dan mengoptimalkan proses pengiriman untuk aset ini. API ini menggunakan ID Microsoft Entra (ID Microsoft Entra) untuk mengautentikasi panggilan dari aplikasi atau layanan Anda. Langkah-langkah berikut menjelaskan proses end-to-end menggunakan Microsoft Hardware API:

  1. API ini hanya dapat digunakan oleh akun milik program Pusat Mitra Perangkat Keras.

  2. Pastikan Anda telah menyelesaikan prasyarat di bawah ini.

  3. Sebelum Anda memanggil metode di Microsoft Hardware API, dapatkan token akses ID Microsoft Entra, seperti yang diilustrasikan di bawah ini. 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 menghasilkan token baru.

  4. Panggil MICROSOFT Hardware API.

Selesaikan prasyarat untuk menggunakan Microsoft Hardware API

Sebelum Anda mulai menulis kode untuk memanggil Microsoft Hardware API, pastikan Anda telah menyelesaikan prasyarat yang diperlukan berikut.

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

  • Jika aplikasi ID Microsoft Entra belum ada, Anda harus membuatnya.

  • Anda harus mengaitkan aplikasi ID Microsoft Entra dengan akun Pusat Mitra Anda dan menetapkan peran Manajer .

  • Kumpulkan ID penyewa aplikasi Microsoft Entra ID, ID klien, dan kunci Anda. Pastikan untuk mencetak atau menyalin info kunci ini, karena Anda tidak akan dapat mengaksesnya lagi setelah Anda meninggalkan halaman pembuatan kunci.

Menetapkan peran Perangkat Keras yang sesuai ke aplikasi ID Microsoft Entra Anda

Setelah Anda menyelesaikan prasyarat di atas, kami sekarang harus menetapkan peran yang sesuai sehingga aplikasi ID Microsoft Entra dapat membuat dan mengelola pengiriman dan label pengiriman.

  1. Dari Pusat Mitra, pilih ikon gigi (di dekat sudut kanan atas dasbor) lalu pilih Pengaturan pengembang. Di menu Pengaturan, pilih Pengguna.

  2. Pada halaman Pengguna , pilih aplikasi ID Microsoft Entra dan aplikasi ID Microsoft Entra yang mewakili aplikasi atau layanan yang akan Anda gunakan untuk mengakses pengiriman untuk akun Pusat Mitra Anda.

  3. Pada halaman ini, di bawah Peran, pilih Perangkat Keras.

    gambar yang memperlihatkan tab Perangkat Keras di bagian Peran.

    Pilih Pengirim Pengirim, Pemilik Label Pengiriman, dan jika tersedia, promotor Label Pengiriman. Pelajari selengkapnya tentang peran ini

Mendapatkan token akses ID Microsoft Entra

Sebelum memanggil salah satu metode di Microsoft Hardware API, Anda harus terlebih dahulu mendapatkan token akses ID Microsoft Entra yang Anda berikan ke header Otorisasi dari setiap metode di API. Setelah mendapatkan token akses, Anda memiliki waktu 60 menit untuk menggunakan token akses 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 kedaluwarsa, Anda dapat merefreshnya dengan mengikuti instruksi dalam Merefresh token akses.

Menggunakan API Perangkat Keras Microsoft

Setelah Anda memiliki token akses ID Microsoft Entra, Anda dapat memanggil metode di MICROSOFT Hardware API. API mencakup banyak metode yang dikelompokkan ke dalam skenario. Untuk membuat atau memperbarui pengiriman, Anda biasanya memanggil beberapa metode di MICROSOFT Hardware API dalam urutan tertentu. Untuk informasi tentang setiap skenario dan sintaks setiap metode, lihat artikel dalam tabel berikut ini.

Skenario Deskripsi
Driver Dapatkan, buat, dan perbarui driver yang terdaftar di Akun Pusat Mitra Anda. Untuk informasi selengkapnya tentang metode ini, lihat artikel berikut ini:

Contoh kode

Sampel berikut menyediakan kode terperinci yang menunjukkan cara menggunakan Microsoft Hardware API bersama dengan solusi bawaan end to end lengkap yang dibuat oleh tim Microsoft Surface and Devices:

sampel API dasbor perangkat keras (GitHub)

Alat Surface Dev Center Manager (GitHub)

Bantuan tambahan

Jika Anda memiliki pertanyaan tentang API pengiriman Microsoft Store atau memerlukan bantuan dalam mengelola pengiriman Anda dengan API ini, kunjungi halaman dukungan dan minta bantuan.

Apa itu ID Microsoft Entra?