Pertimbangan API

Penerapan versi API

Catatan

API Portal Mitra Cloud terintegrasi dengan dan akan terus bekerja di Pusat Mitra. Transisi memperkenalkan perubahan kecil. Tinjau perubahan yang tercantum di Referensi API Portal Mitra Cloud untuk memastikan kode Anda terus berfungsi setelah transisi 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.

Mungkin ada beberapa versi API yang tersedia secara bersamaan. Klien harus menunjukkan versi mana yang ingin mereka gunakan dengan memberikan parameter api-version sebagai bagian dari string kueri.

GET https://cloudpartner.azure.com/api/offerTypes?api-version=2017-10-31

Respons terhadap permintaan dengan versi API yang tidak dikenal atau tidak valid adalah kode HTTP 400. Kesalahan ini menampilkan koleksi versi API umum dalam isi respons.

    {
        "error": { 
            "code":"InvalidAPIVersion",
            "message":"Invalid api version. Allowed values are [2016-08-01-preview]"
        }
    }

Kesalahan

API menanggapi kesalahan dengan kode status HTTP yang sesuai dan secara opsional, informasi tambahan dalam respons yang diserialisasikan sebagai JSON. Saat Anda menerima kesalahan, terutama kesalahan kelas 400, jangan mencoba kembali permintaan sebelum memperbaiki penyebab yang mendasarinya. Misalnya, dalam respons sampel di atas, perbaiki parameter versi API sebelum mengirim ulang permintaan.

Header otorisasi

Untuk semua API dalam referensi ini, Anda harus meneruskan header otorisasi bersama dengan token pembawa yang diperoleh dari ID Microsoft Entra. Header ini diperlukan untuk menerima respons yang valid; jika tidak ada, kesalahan 401 Unauthorized akan ditampilkan.

  GET https://cloudpartner.azure.com/api/offerTypes?api-version=2016-08-01-preview

    Accept: application/json 
    Authorization: Bearer <YOUR_TOKEN>