Referensi model data templat Azure API Management

  • Artikel

Topik ini menjelaskan entitas dan jenis representasi untuk item umum yang digunakan dalam model data untuk templat portal pengembang di Azure API Management.

Untuk informasi selengkapnya tentang bekerja dengan templat, lihat Cara mengustomisasi portal pengembang API Management menggunakan templat.

Catatan

Konten dokumentasi berikut berisi tentang portal pengembang yang tidak digunakan lagi. Anda dapat terus menggunakannya seperti biasa, hingga waktu pensiunnya pada bulan Oktober 2023, saat portal tersebut akan dihapus dari semua layanan API Management. Portal yang tidak digunakan lagi hanya akan menerima pembaruan keamanan yang penting. Lihat artikel berikut ini untuk detail selengkapnya:

Ketersediaan

Penting

Fitur ini tersedia di tingkat Premium, Standar, Dasar, dan Pengembang API Management.

Untuk ketersediaan fitur di tingkat v2 (pratinjau), lihat gambaran umum tingkat v2.

Referensi

API

Entitas API memiliki properti berikut:

Properti Jenis Deskripsi
id string Pengidentifikasi sumber daya. Mengidentifikasi API secara unik dalam instans layanan API Management saat ini. Nilai tersebut adalah URL relatif yang valid dalam format apis/{id} di mana {id} merupakan pengidentifikasi API. Properti ini bersifat hanya baca.
name string Nama API. Tidak boleh kosong. Panjang maksimum adalah 100 karakter.
description string Deskripsi API. Tidak boleh kosong. Mungkin menyertakan tag pemformatan HTML. Panjang maksimum adalah 1000 karakter.
serviceUrl string URL absolut dari layanan backend yang mengimplementasikan API ini.
path string URL relatif secara unik mengidentifikasi API ini dan semua jalur sumber dayanya dalam instans layanan API Management. Ini ditambahkan ke URL basis titik akhir API yang ditentukan selama pembuatan instans layanan untuk membentuk URL publik untuk API ini.
protocols array angka Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini. Nilai yang diperbolehkan adalah 1 - http dan 2 - https, atau keduanya.
authenticationSettings Pengaturan autentikasi server otorisasi Kumpulan pengaturan autentikasi yang disertakan dalam API ini.
subscriptionKeyParameterNames objek Properti opsional yang bisa digunakan untuk menentukan nama kustom untuk parameter kueri dan/atau header yang berisi kunci langganan. Ketika properti ini ada, properti harus berisi setidaknya satu dari dua properti berikut.

{ "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } }

Ringkasan API

Entitas API summary memiliki properti berikut:

Properti Jenis Deskripsi
id string Pengidentifikasi sumber daya. Mengidentifikasi API secara unik dalam instans layanan API Management saat ini. Nilai tersebut adalah URL relatif yang valid dalam format apis/{id} di mana {id} merupakan pengidentifikasi API. Properti ini bersifat hanya baca.
name string Nama API. Tidak boleh kosong. Panjang maksimum adalah 100 karakter.
description string Deskripsi API. Tidak boleh kosong. Mungkin menyertakan tag pemformatan HTML. Panjang maksimum adalah 1000 karakter.

Aplikasi

Entitas application memiliki properti berikut:

Properti Jenis Deskripsi
Id string Pengidentifikasi unik aplikasi.
Title string Judul aplikasi.
Description string Deskripsi aplikasi.
Url URI URI untuk aplikasi.
Version string Informasi versi untuk aplikasi.
Requirements string Deskripsi persyaratan untuk aplikasi.
State nomor Status aplikasi saat ini.

- 0 - Terdaftar

- 1 - Diajukan

- 2 - Diterbitkan

- 3 - Ditolak

- 4 - Tidak diterbitkan
RegistrationDate DateTime Tanggal dan waktu aplikasi didaftarkan.
CategoryId nomor Kategori aplikasi (Keuangan, hiburan, dll.)
DeveloperId string Pengidentifikasi unik pengembang yang mengirimkan aplikasi.
Attachments Kumpulan entitas Lampiran. Lampiran apa pun untuk aplikasi seperti tangkapan layar atau ikon.
Icon Lampiran Ikon untuk aplikasi.

Lampiran

Entitas attachment memiliki properti berikut:

Properti Jenis Deskripsi
UniqueId string Pengidentifikasi unik untuk lampiran.
Url string URL sumber daya.
Type string Jenis lampiran.
ContentType string Jenis media lampiran.

Sampel kode

Properti Jenis Deskripsi
title string Nama operasi.
snippet string Properti ini sudah tidak digunakan lagi dan tidak boleh digunakan.
brush string Templat pewarnaan sintaks kode mana yang akan digunakan saat menampilkan sampel kode. Nilai yang diperbolehkan adalah plain, php, java, xml, objc, python, ruby, dan csharp.
template string Nama templat sampel kode ini.
body string Tempat penampung untuk bagian sampel kode dari cuplikan.
method string Metode operasi HTTP.
scheme string Protokol yang akan digunakan untuk permintaan operasi.
path string Jalur operasi.
query string Contoh string kueri dengan parameter yang ditentukan.
host string URL gateway layanan API Management untuk API yang berisi operasi ini.
headers Kumpulan entitas Header. Header untuk operasi ini.
parameters Kumpulan entitas Parameter. Parameter yang didefinisikan untuk operasi ini.

Komentar

Entitas API memiliki properti berikut:

Properti Jenis Deskripsi
Id nomor ID komentar.
CommentText string Bodi komentar. Mungkin termasuk HTML.
DeveloperCompany string Nama perusahaan pengembang.
PostedOn DateTime Tanggal dan waktu komentar diposting.

Masalah

Entitas issue memiliki properti berikut.

Properti Jenis Deskripsi
Id string Pengidentifikasi unik untuk masalah ini.
ApiID string ID untuk API tempat masalah ini dilaporkan.
Title string Judul masalah.
Description string Deskripsi masalah.
SubscriptionDeveloperName string Nama depan pengembang yang melaporkan masalah ini.
IssueState string Status masalah saat ini. Nilai yang mungkin Diusulkan, Dibuka, Ditutup.
ReportedOn DateTime Tanggal dan waktu masalah dilaporkan.
Comments Kumpulan entitas Komentar. Komentar pada masalah ini.
Attachments Kumpulan entitas Lampiran. Lampiran apa pun untuk masalah ini.
Services Kumpulan entitas API. API yang dilanggan oleh pengguna yang mengajukan masalah.

Pemfilteran

Entitas filtering memiliki properti berikut:

Properti Jenis Deskripsi
Pattern string Istilah pencarian saat ini; atau null jika tidak ada istilah pencarian.
Placeholder string Teks yang ditampilkan di kotak pencarian saat tidak ada istilah pencarian yang ditentukan.

Bagian ini menjelaskan representasi parameter.

Properti Jenis Deskripsi
name string Nama parameter.
description string Deskripsi parameter.
value string Nilai header.
typeName string Tipe data nilai header.
options string Opsi.
required boolean Apakah header diperlukan.
readOnly boolean Apakah header bersifat hanya baca.

Permintaan HTTP

Bagian ini menjelaskan representasi request.

Properti Jenis Deskripsi
description string Deskripsi permintaan operasi.
headers array entitas Header. Header permintaan.
parameters array Parameter Kumpulan parameter permintaan operasi.
representations array Representasi Kumpulan representasi permintaan operasi.

Respons HTTP

Bagian ini menjelaskan representasi response.

Properti Jenis Deskripsi
statusCode bilangan bulat positif Kode status respons operasi.
description string Deskripsi respons operasi.
representations array Representasi Kumpulan representasi permintaan operasi.

Operasi

Entitas operation memiliki properti berikut:

Properti Jenis Deskripsi
id string Pengidentifikasi sumber daya. Mengidentifikasi operasi secara unik dalam instans layanan API Management saat ini. Nilai tersebut adalah URL relatif yang valid dalam format apis/{aid}/operations/{id} di mana {aid} merupakan pengidentifikasi API dan {id} merupakan pengidentifikasi operasi. Properti ini bersifat hanya baca.
name string Nama operasi. Tidak boleh kosong. Panjang maksimum adalah 100 karakter.
description string Deskripsi operasi. Tidak boleh kosong. Mungkin menyertakan tag pemformatan HTML. Panjang maksimum adalah 1000 karakter.
scheme string Menjelaskan protokol mana yang dapat dipanggil oleh operasi dalam API ini. Nilai yang diperbolehkan adalah http, https, atau kedua http dan https.
uriTemplate string Templat URL relatif mengidentifikasi sumber daya target untuk operasi ini. Dapat mencakup parameter. Contoh: customers/{cid}/orders/{oid}/?date={date}
host string URL gateway API Management yang menghosting API.
httpMethod string Metode operasi HTTP.
request Permintaan HTTP Entitas yang berisi detail permintaan.
responses array Respons HTTP Array operasi entitas Respons HTTP.

Entitas operation menu memiliki properti berikut:

Properti Jenis Deskripsi
ApiId string ID dari API saat ini.
CurrentOperationId string ID operasi saat ini.
Action string Jenis menu.
MenuItems Kumpulan entitas Item menu operasi. Operasi untuk API saat ini.

Entitas operation menu item memiliki properti berikut:

Properti Jenis Deskripsi
Id string ID operasi.
Title string Deskripsi operasi.
HttpMethod string Metode operasi HTTP.

Penomoran

Entitas paging memiliki properti berikut:

Properti Jenis Deskripsi
Page nomor Nomor halaman saat ini.
PageSize nomor Hasil maksimum yang akan ditampilkan pada satu halaman.
TotalItemCount nomor Jumlah item untuk ditampilkan.
ShowAll boolean Apakah akan menampilkan semua hasil dalam satu halaman.
PageCount nomor Jumlah halaman hasil.

Parameter

Bagian ini menjelaskan representasi parameter.

Properti Jenis Deskripsi
name string Nama parameter.
description string Deskripsi parameter.
value string Nilai parameter.
options array string Nilai yang ditentukan untuk nilai parameter kueri.
required boolean Menentukan apakah parameter diperlukan atau tidak.
kind nomor Apakah parameter ini adalah parameter jalur (1), atau parameter querystring (2).
typeName string Jenis parameter.

Produk

Entitas product memiliki properti berikut:

Properti Jenis Deskripsi
Id string Pengidentifikasi sumber daya. Mengidentifikasi produk secara unik dalam instans layanan API Management saat ini. Nilai tersebut adalah URL relatif yang valid dalam format products/{pid} di mana {pid} merupakan pengidentifikasi produk. Properti ini bersifat hanya baca.
Title string Nama produk. Tidak boleh kosong. Panjang maksimum adalah 100 karakter.
Description string Deskripsi produk. Tidak boleh kosong. Mungkin menyertakan tag pemformatan HTML. Panjang maksimum adalah 1000 karakter.
Terms string Persyaratan penggunaan produk. Pengembang yang mencoba berlangganan produk akan disajikan dan diharuskan untuk menerima persyaratan ini sebelum mereka dapat menyelesaikan proses berlangganan.
ProductState nomor Menentukan apakah produk dipublikasikan atau tidak. Produk yang dipublikasikan dapat ditemukan oleh pengembang di portal pengembang. Produk yang tidak dipublikasikan hanya dapat dilihat oleh administrator.

Nilai yang diperbolehkan untuk status produk adalah:

- 0 - Not Published

- 1 - Published

- 2 - Deleted
AllowMultipleSubscriptions boolean Menentukan apakah pengguna dapat memiliki beberapa langganan untuk produk ini secara bersamaan.
MultipleSubscriptionsCount nomor Jumlah maksimum langganan untuk produk ini yang diizinkan bagi pengguna untuk memilikinya pada saat yang sama.

Penyedia

Entitas provider memiliki properti berikut:

Properti Jenis Deskripsi
Properties kamus string Properti untuk penyedia autentikasi ini.
AuthenticationType string Jenis penyedia. (Microsoft Entra ID, login Facebook, Akun Google, Akun Microsoft, Twitter).
Caption string Nama tampilan penyedia.

Representasi

Bagian ini menjelaskan representation.

Properti Jenis Deskripsi
contentType string Menentukan jenis konten terdaftar atau kustom untuk representasi ini, misalnya, application/xml.
sample string Contoh representasi.

Langganan

Entitas subscription memiliki properti berikut:

Properti Jenis Deskripsi
Id string Pengidentifikasi sumber daya. Mengidentifikasi langganan secara unik dalam instans layanan API Management saat ini. Nilai tersebut adalah URL relatif yang valid dalam format subscriptions/{sid} di mana {sid} merupakan pengidentifikasi langganan. Properti ini bersifat hanya baca.
ProductId string Pengidentifikasi sumber daya produk dari produk yang dilanggani. Nilai tersebut adalah URL relatif yang valid dalam format products/{pid} di mana {pid} merupakan pengidentifikasi produk.
ProductTitle string Nama produk. Tidak boleh kosong. Panjang maksimum adalah 100 karakter.
ProductDescription string Deskripsi produk. Tidak boleh kosong. Mungkin menyertakan tag pemformatan HTML. Panjang maksimum adalah 1000 karakter.
ProductDetailsUrl string URL relatif terhadap detail produk.
state string Status langganan. Kemungkinan status adalah:

- 0 - suspended – langganan diblokir, dan pelanggan tidak dapat memanggil API produk apa pun.

- 1 - active – langganan aktif.

- 2 - expired – langganan mencapai tanggal kedaluwarsa dan dinonaktifkan.

- 3 - submitted – permintaan berlangganan telah dibuat oleh pengembang, tetapi belum disetujui atau ditolak.

- 4 - rejected – permintaan langganan telah ditolak oleh administrator.

- 5 - cancelled – langganan telah dibatalkan oleh pengembang atau administrator.
DisplayName string Nama tampilan langganan.
CreatedDate dateTime Tanggal langganan dibuat, dalam format ISO 8601: 2014-06-24T16:25:00Z.
CanBeCancelled boolean Apakah langganan dapat dibatalkan oleh pengguna saat ini.
IsAwaitingApproval boolean Apakah langganan sedang menunggu persetujuan.
StartDate dateTime Tanggal mulai untuk langganan, dalam format ISO 8601: 2014-06-24T16:25:00Z.
ExpirationDate dateTime Tanggal kedaluwarsa untuk langganan, dalam format ISO 8601: 2014-06-24T16:25:00Z.
NotificationDate dateTime Tanggal pemberitahuan untuk langganan, dalam format ISO 8601: 2014-06-24T16:25:00Z.
primaryKey string Kunci langganan utama. Panjang maksimum adalah 256 karakter.
secondaryKey string Kunci langganan utama. Panjang maksimum adalah 256 karakter.
CanBeRenewed boolean Apakah langganan dapat diperbarui oleh pengguna saat ini.
HasExpired boolean Apakah langganan telah kedaluwarsa.
IsRejected boolean Apakah permintaan langganan ditolak.
CancelUrl string Url relatif untuk membatalkan langganan.
RenewUrl string Url relatif untuk memperbarui langganan.

Ringkasan langganan

Entitas subscription summary memiliki properti berikut:

Properti Jenis Deskripsi
Id string Pengidentifikasi sumber daya. Mengidentifikasi langganan secara unik dalam instans layanan API Management saat ini. Nilai tersebut adalah URL relatif yang valid dalam format subscriptions/{sid} di mana {sid} merupakan pengidentifikasi langganan. Properti ini bersifat hanya baca.
DisplayName string Nama tampilan langganan

Info akun pengguna

Entitas user account info memiliki properti berikut:

Properti Jenis Deskripsi
FirstName string Nama depan. Tidak boleh kosong. Panjang maksimum adalah 100 karakter.
LastName string Nama belakang. Tidak boleh kosong. Panjang maksimum adalah 100 karakter.
Email string Alamat Email. Tidak boleh kosong dan harus unik dalam instans layanan. Panjang maksimum adalah 254 karakter.
Password string Kata sandi akun pengguna.
NameIdentifier string Pengidentifikasi akun, sama dengan email pengguna.
ProviderName string Nama penyedia autentikasi.
IsBasicAccount boolean Benar, jika akun ini didaftarkan menggunakan email dan kata sandi; salah, jika akun didaftarkan menggunakan penyedia.

Rincian masuk pengguna

Entitas user sign in memiliki properti berikut:

Properti Jenis Deskripsi
Email string Alamat Email. Tidak boleh kosong dan harus unik dalam instans layanan. Panjang maksimum adalah 254 karakter.
Password string Kata sandi akun pengguna.
ReturnUrl string URL halaman tempat pengguna mengklik masuk.
RememberMe boolean Apakah akan menyimpan informasi pengguna saat ini.
RegistrationEnabled boolean Apakah pendaftaran diaktifkan.
DelegationEnabled boolean Apakah masuk yang didelegasikan diaktifkan.
DelegationUrl string Url masuk yang didelegasikan, jika diaktifkan.
SsoSignUpUrl string URL sistem masuk tunggal untuk pengguna, jika ada.
AuxServiceUrl string Jika pengguna saat ini adalah administrator, ini adalah tautan ke instans layanan di portal Microsoft Azure.
Providers Kumpulan entitas Penyedia Penyedia autentikasi untuk pengguna ini.
UserRegistrationTerms string Persyaratan yang harus disetujui pengguna sebelum masuk.
UserRegistrationTermsEnabled boolean Apakah persyaratan diaktifkan.

Pendaftaran pengguna

Entitas user sign up memiliki properti berikut:

Properti Jenis Deskripsi
PasswordConfirm boolean Nilai yang digunakan oleh kontrol pendaftaran pendaftaran.
Password string Kata sandi akun pengguna.
PasswordVerdictLevel nomor Nilai yang digunakan oleh kontrol pendaftaran pendaftaran.
UserRegistrationTerms string Persyaratan yang harus disetujui pengguna sebelum masuk.
UserRegistrationTermsOptions nomor Nilai yang digunakan oleh kontrol pendaftaran pendaftaran.
ConsentAccepted boolean Nilai yang digunakan oleh kontrol pendaftaran pendaftaran.
Email string Alamat Email. Tidak boleh kosong dan harus unik dalam instans layanan. Panjang maksimum adalah 254 karakter.
FirstName string Nama depan. Tidak boleh kosong. Panjang maksimum adalah 100 karakter.
LastName string Nama belakang. Tidak boleh kosong. Panjang maksimum adalah 100 karakter.
UserData string Nilai yang digunakan oleh kontrol pendaftaran.
NameIdentifier string Nilai yang digunakan oleh kontrol pendaftaran pendaftaran.
ProviderName string Nama penyedia autentikasi.

Langkah berikutnya

Untuk informasi selengkapnya tentang bekerja dengan templat, lihat Cara mengustomisasi portal pengembang API Management menggunakan templat.