Bagikan melalui

Manajemen langsung API Management REST API

  • Artikel

Azure API Management menyediakan REST API manajemen langsung untuk melakukan operasi pada entitas yang dipilih, seperti pengguna, grup, produk, dan langganan. API manajemen langsung dapat melewati batas tertentu dari API berbasis Azure Resource Manager, seperti pembatasan permintaan.

Penting

Bagian ini menjelaskan cara mengakses manajemen langsung API Management REST API. API ini memiliki mekanisme autentikasi yang berbeda dari Azure Resource Manager dan menggunakan URL dasar yang berbeda.

Mengaktifkan akses ke REST API manajemen langsung

Akses ke manajemen langsung API Management REST API harus diberikan sebelum panggilan berhasil dilakukan.

  1. Navigasi ke instans API Management Azure Anda di portal Azure.

  2. Pilih API Manajemen dari bagian Penyebaran + infrastruktur menu di sebelah kiri.

    Pilih API Manajemen di portal Azure

  3. Di Aktifkan API Management REST API, pilih Ya.

    Penting

    Jika Aktifkan API Management REST API tidak dipilih, panggilan yang dilakukan ke REST API untuk instans layanan tersebut akan gagal.

    Mengaktifkan API API Management di portal Azure

Jenis media default

Jenis media default untuk permintaan dan respons adalah application/json. Jika dicatat, beberapa operasi mendukung jenis konten lainnya. Jika tidak ada jenis konten tambahan yang disebutkan untuk operasi tertentu, maka jenis medianya adalah application/json.

Autentikasi

Setiap permintaan ke API Management REST API harus disertai dengan header yang Authorization berisi token akses bersama yang valid, seperti yang ditunjukkan dalam contoh berikut.

Authorization: SharedAccessSignature uid=53dd860e1b72ff0467030003&ex=2014-08-04T22:03:00.0000000Z&sn=ItH6scUyCazNKHULKA0Yv6T+Skk4bdVmLqcPPPdWoxl2n1+rVbhKlplFrqjkoUFRr0og4wjeDz4yfThC82OjfQ==

Token akses ini dapat dihasilkan secara terprogram atau dari dalam portal penerbit API Management. Untuk instruksi tentang membuat dan mengambil token akses, lihat Untuk membuat token akses secara manual dan Untuk membuat token akses secara terprogram.

URL Dasar

URL Dasar dari manajemen langsung API Management REST API sesuai dengan templat berikut.

https://{servicename}.management.azure-api.net

Templat ini berisi parameter berikut.

  • {serviceName} adalah nama layanan seperti yang ditentukan selama pembuatan layanan, misalnya https://contosoapi.management.azure-api.net.

Semua URL yang dikembalikan oleh API Management REST API relatif terhadap URL dasar ini, dan semua permintaan ke REST API harus menggunakan templat URL dasar ini.

Parameter Kueri Versi

Semua operasi mengharapkan api-version parameter kueri dengan nilai dalam format YYYY-MM-DD, misalnya 2021-08-01.

Catatan

Selama periode pratinjau untuk API Management REST API, -preview ditambahkan ke parameter kueri versi, misalnya 2021-04-01-preview.

Jika parameter kueri ini tidak diteruskan dalam string kueri permintaan, server akan mengembalikan kode 400 Bad Requeststatus . Untuk daftar versi yang didukung, lihat API Management referensi REST API.

Langkah berikutnya