Cara mengonfigurasi pemberitahuan dan templat pemberitahuan di Azure API Management

BERLAKU UNTUK: Pengembang | Basic | Basic v2 | Standar | Standar v2 | Premium | Premium v2

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

Prerequisites

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

Buka instans Manajemen API Anda

1. Di portal Azure , cari dan pilih layanan API Management :

   

2. Pada halaman layanan API Management , pilih instans API Management Anda:

   

Mengonfigurasi pemberitahuan di portal Microsoft Azure

1. Dari menu bilah samping instans API Management Anda, pilih Penyebaran + infrastruktur, lalu pilih Pemberitahuan untuk melihat pemberitahuan yang tersedia.

   Daftar peristiwa berikut dapat dikonfigurasi untuk pemberitahuan.

   • Permintaan langganan (memerlukan persetujuan): Penerima email dan pengguna yang ditentukan menerima pemberitahuan email tentang permintaan langganan untuk produk yang memerlukan persetujuan.
   • Langganan baru: Penerima email dan pengguna yang ditentukan menerima pemberitahuan email tentang langganan produk baru.
   • Permintaan pada galeri aplikasi: Penerima email dan pengguna berikut akan menerima notifikasi email ketika aplikasi baru dikirimkan ke galeri aplikasi.
   • BCC: Penerima email dan pengguna yang ditentukan menerima salinan karbon buta email dari semua email yang dikirim ke pengembang.
   • Masalah atau komentar baru: Penerima email dan pengguna berikut menerima pemberitahuan email saat masalah atau komentar baru dikirimkan di portal pengembang.
   • Tutup pesan akun: Penerima email dan pengguna yang ditentukan menerima pemberitahuan email saat akun ditutup.
   • Mendekati batas kuota langganan: Penerima email dan pengguna yang ditentukan menerima pemberitahuan email saat penggunaan langganan mendekati kuota penggunaan.

2. 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 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:

• Surat perpisahan pengembang
• Pemberitahuan batas kuota pengembang hampir mencapai
• Surat selamat datang pengembang
• Pemberitahuan perubahan email
• Undang pengguna
• Konfirmasi akun pengembang baru
• Langganan baru diaktifkan
• Konfirmasi perubahan kata sandi
• Permintaan langganan ditolak
• Permintaan langganan diterima

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

Note

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

Untuk melihat dan mengonfigurasi templat pemberitahuan di portal:

1. Di menu bilah samping, pilih Templat pemberitahuan.

2. Pilih templat pemberitahuan, dan konfigurasikan templat menggunakan editor.

   

   • Daftar Parameter berisi daftar parameter yang, saat dimasukkan ke dalam subjek atau isi, digantikan oleh nilai yang ditunjuk saat email dikirim.
   • Untuk menyisipkan parameter, letakkan kursor tempat Anda ingin parameter pergi, dan pilih nama parameter.

3. Untuk menyimpan perubahan pada templat email, pilih Simpan, atau pilih Buang untuk membatalkan perubahan.

Mengonfigurasi pengaturan email

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

Important

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

Untuk mengubah pengaturan email:

1. Di menu bilah samping, pilih Templat pemberitahuan.

2. Pilih Pengaturan email.

3. Pada halaman Pengaturan email umum , masukkan nilai untuk:

   • Email administrator: alamat email untuk menerima semua pemberitahuan sistem dan pemberitahuan lain yang dikonfigurasi.

   • Nama organisasi: nama organisasi Anda untuk 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.

     

4. Pilih Simpan.

Pertimbangan untuk mengubah alamat email asal

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

• Ubah alamat Dari: Saat Anda mengubah alamat email asal (misalnya, menjadi no-reply@contoso.com), header Dari 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 yang dikirim 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.

Konten terkait

• Gambaran umum portal pengembang
• Cara membuat dan menggunakan grup untuk mengelola akun pengembang