Cara mengonfigurasi pemberitahuan dan templat pemberitahuan di Azure API Management

Artikel
04/04/2024

API Manajemen menyediakan kemampuan untuk mengonfigurasi pemberitahuan email tentang peristiwa tertentu, dan untuk mengonfigurasi templat email yang digunakan untuk berkomunikasi dengan administrator dan pengembang instans API Management. Artikel ini memperlihatkan cara mengonfigurasi pemberitahuan untuk acara yang tersedia, dan memberikan gambaran umum tentang mengonfigurasi templat email yang digunakan untuk peristiwa ini.

Prasyarat

Jika Anda tidak memiliki instans layanan API Management, selesaikan mulai cepat berikut: Membuat instans Azure API Management.

Membuka instans API Management Anda

Di portal Microsoft Azure, cari dan pilih layanan API Management.
Di halaman layanan API Management, pilih instans API Management Anda.

Mengonfigurasi pemberitahuan di portal

Di navigasi kiri instans API Management Anda, pilih Pemberitahuan untuk melihat pemberitahuan yang tersedia.

Daftar peristiwa berikut ini dapat dikonfigurasi untuk pemberitahuan.
- Permintaan langganan (memerlukan persetujuan) - Penerima email dan pengguna yang ditentukan akan menerima pemberitahuan email tentang permintaan langganan untuk produk API yang memerlukan persetujuan.
- Langganan baru - Penerima email dan pengguna yang ditentukan akan menerima pemberitahuan email tentang langganan produk baru.
- BCC - Penerima email dan pengguna yang ditentukan akan menerima blind carbon copy email dari semua email yang dikirim ke pengembang.
- Pesan tutup akun - Penerima email dan pengguna yang ditentukan akan menerima pemberitahuan email saat akun ditutup.
- Mendekati batas kuota langganan - Penerima email dan pengguna yang ditentukan akan menerima pemberitahuan email saat penggunaan langganan mendekati kuota penggunaan.
  
  Catatan
  
  Notifikasi hanya dipicu oleh kebijakan kuota berdasarkan langganan. Kebijakan kuota berdasarkan kunci tidak menghasilkan pemberitahuan.
Pilih pemberitahuan, dan tentukan satu atau beberapa alamat email yang akan diberi tahu:
- Untuk menambahkan alamat email administrator, pilih + Tambahkan admin.
- Untuk menambahkan alamat email lain, pilih + Tambahkan email, masukkan alamat email, dan pilih Tambahkan.
- Lanjutkan untuk menambahkan alamat email sesuai kebutuhan.

Mengonfigurasi templat pemberitahuan

API Management menyediakan templat pemberitahuan untuk pesan email administratif yang dikirim secara otomatis ke pengembang saat mereka mengakses dan menggunakan layanan. Templat pemberitahuan berikut disediakan:

Pengajuan galeri aplikasi disetujui (tidak digunakan lagi)
Surat perpisahan pengembang
Pemberitahuan mendekati batas kuota pengembang
Surat selamat datang pengembang
Pemberitahuan tentang perubahan email
Mengundang pengguna
Komentar baru terkait masalah ditambahkan (tidak digunakan lagi)
Konfirmasi akun pengembang baru
Masalah baru diterima (tidak digunakan lagi)
Langganan baru diaktifkan
Konfirmasi perubahan kata sandi
Permintaan langganan ditolak
Permintaan langganan diterima

Setiap templat email memiliki subjek dalam teks biasa, dan definisi isi dalam format HTML. Setiap item dapat dikustomisasi sesuai keinginan.

Catatan

Konten HTML dalam templat harus dibentuk dengan baik dan mematuhi spesifikasi XML. Karakter   tidak diizinkan.

Untuk melihat dan mengonfigurasi templat pemberitahuan di portal:

Di menu sebelah kiri, pilih Templat solusi.
Pilih templat pemberitahuan, dan konfigurasikan templat menggunakan editor.
- Daftar Parameter berisi daftar parameter, yang ketika dimasukkan ke dalam subjek atau isi, akan diganti dengan nilai yang ditentukan ketika email dikirim.
- Untuk memasukkan parameter, letakkan kursor di tempat yang Anda inginkan untuk parameter tersebut, lalu pilih nama parameter.
Untuk menyimpan perubahan templat email, klik Simpan, sedangkan untuk membatalkan perubahan klik Buang.

Mengonfigurasikan pengaturan email

Anda dapat mengubah pengaturan surel umum terkait pemberitahuan yang dikirim dari instans API Management Anda. Anda dapat mengubah alamat email administrator, nama organisasi yang mengirim pemberitahuan, dan alamat email asal.

Penting

Mengubah alamat email asal dapat memengaruhi kemampuan penerima untuk menerima email. Lihat pertimbangan di bagian berikut.

Untuk mengubah pengaturan email:

Di menu sebelah kiri, pilih Templat solusi.
Pilih Pengaturan email.
Pada halaman Pengaturan email umum, masukkan nilai untuk:
- Email administrator - alamat email untuk menerima semua pemberitahuan sistem dan pemberitahuan lain yang telah dikonfigurasi
- Nama organisasi - nama organisasi Anda yang akan digunakan di portal pengembang dan pemberitahuan
- Alamat email asal - Nilai header From untuk pemberitahuan dari instans API Management. API Management mengirimkan pemberitahuan atas nama alamat asal ini.
Pilih Simpan.

Pertimbangan untuk mengubah alamat email asal

Penerima pemberitahuan email dari API Management dapat terpengaruh saat Anda mengubah alamat email asal.

Ubah ke Dari alamat - Saat Anda mengubah alamat email asal (misalnya, menjadi no-reply@contoso.com), From header alamat akan menjadi noreply@contoso.com apimgmt-noreply@mail.windowsazure.com. Ini karena email sedang dikirim oleh API Management, dan bukan server email dari alamat email asal.
Email diatur ke folder Sampah atau Spam - Beberapa penerima mungkin tidak menerima pemberitahuan email dari API Management atau email mungkin dikirim ke folder Sampah atau Spam. Ini dapat terjadi tergantung pada pengaturan autentikasi email SPF atau DKIM organisasi:
- Autentikasi SPF - Email mungkin tidak lagi melewati autentikasi SPF setelah Anda mengubah domain alamat email asal. Untuk memastikan keberhasilan autentikasi SPF dan pengiriman email, buat catatan TXT berikut ini di database DNS domain yang ditentukan dalam alamat email. Misalnya, jika alamat email adalah noreply@contoso.com, hubungi administrator contoso.com untuk menambahkan catatan TXT berikut: "v=spf1 include:spf.protection.outlook.com include:_spf-ssg-a.microsoft.com -all"
- Autentikasi DKIM - Untuk menghasilkan tanda tangan yang valid untuk DKIM untuk autentikasi email, API Management memerlukan kunci privat yang terkait dengan domain alamat email asal. Namun, saat ini tidak dimungkinkan untuk mengunggah kunci privat ini di API Management. Oleh karena itu, untuk menetapkan tanda tangan yang valid, API Management menggunakan kunci privat yang terkait dengan mail.windowsazure.com domain.