Menyiapkan notifikasi menggunakan template notifikasi

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Apa yang dimaksud dengan template notifikasi?

Monetisasi menyediakan serangkaian template yang menentukan contoh teks untuk berbagai jenis notifikasi peristiwa. Anda dapat menyesuaikan salah satu template ini untuk:

• Memberi tahu semua developer tentang acara seperti produk baru, versi baru Persyaratan dan Ketentuan, atau paket tarif baru.
• Memberi tahu developer yang terpengaruh tentang peristiwa seperti paket tarif yang direvisi.
• Memberi tahu penyedia API tentang peristiwa terkait developer seperti saat developer mendaftar untuk mendapatkan akun atau saat developer mendaftar ke paket tarif.
• Memberi tahu semua administrator perusahaan tentang peristiwa tertentu.

Atau, Anda dapat membuat webhook yang menentukan handler callback HTTP, lalu mengonfigurasi kondisi yang memicu webhook, seperti yang dijelaskan dalam Menyiapkan notifikasi menggunakan webhook.

Menjelajahi halaman Notifikasi

Akses halaman Notifikasi, seperti yang dijelaskan di bawah.

Mengedit notifikasi

Untuk mengedit notifikasi menggunakan UI:

1. Buka halaman Notifikasi.
2. Klik di samping notifikasi yang ingin Anda edit untuk meluaskan detailnya.
3. Edit kolom Subjek, Isi, dan Penerima (jika tersedia), sesuai kebutuhan.

   Untuk mengetahui informasi tentang variabel yang dapat ditentukan dalam template notifikasi, lihat Menggunakan variabel dalam template notifikasi.

   Lihat bagian berikut untuk mengetahui informasi selengkapnya tentang cara mengedit notifikasi di setiap kategori:

   • Mengedit notifikasi untuk Memberi Tahu Semua Developer
   • Mengedit notifikasi untuk Memberi Tahu Developer yang Terpengaruh
   • Mengedit notifikasi untuk Memberi Tahu Penyedia API
4. Aktifkan notifikasi dengan mencentang kotak di sampingnya.
5. Ulangi langkah 2 hingga 4 untuk mengedit notifikasi tambahan.
6. Klik Simpan untuk menyimpan semua perubahan.

Pesan akan ditampilkan untuk mengonfirmasi bahwa notifikasi telah disimpan. Operasi penyimpanan mungkin memerlukan waktu beberapa menit.

Mengedit notifikasi untuk Memberi Notifikasi kepada Semua Developer

Notifikasi untuk jenis peristiwa yang Anda pilih di bagian Beri Notifikasi Semua Developer dikirim ke semua developer.

Notifikasi dijadwalkan untuk berjalan di akhir hari. Setelah notifikasi dikirim, kotak centang acara akan otomatis dihapus. Anda harus memilihnya lagi untuk menjadwalkan notifikasi untuk jenis peristiwa terkait.

Tabel berikut mencantumkan notifikasi berdasarkan jenis peristiwa di bagian Beri Notifikasi Semua Developer. Untuk mengetahui informasi selengkapnya, lihat Mengedit notifikasi menggunakan UI.

Mengedit notifikasi untuk Memberi Tahu Developer yang Terpengaruh

Notifikasi untuk jenis peristiwa yang Anda pilih di bagian Beri Notifikasi kepada Developer yang Terpengaruh hanya dikirimkan kepada developer yang terpengaruh oleh jenis peristiwa tersebut. Misalnya, jika Anda memilih peristiwa Paket tarif yang direvisi, notifikasi hanya dikirim ke developer yang telah menyetujui paket tarif.

Tabel berikut mencantumkan notifikasi berdasarkan jenis peristiwa di bagian Beri Notifikasi kepada Developer yang Terpengaruh. Untuk mengetahui informasi selengkapnya, lihat Mengedit notifikasi menggunakan UI.

Mengedit notifikasi untuk Penyedia API Notifikasi

Notifikasi untuk jenis peristiwa yang Anda pilih di bagian Notify API Provider dikirim ke penyedia API yang Anda tentukan.

Tabel berikut mencantumkan notifikasi berdasarkan jenis peristiwa di bagian Penyedia API Notifikasi. Untuk mengetahui informasi selengkapnya, lihat Mengedit notifikasi menggunakan UI.

Mengaktifkan atau menonaktifkan notifikasi

Untuk mengaktifkan atau menonaktifkan notifikasi menggunakan UI:

1. Buka halaman Notifikasi.
2. Aktifkan atau nonaktifkan notifikasi dengan memilih atau membatalkan pilihan kotak centang di sampingnya.
3. Klik Simpan untuk menyimpan semua perubahan.

Operasi penyimpanan mungkin memerlukan waktu beberapa menit. Pesan akan ditampilkan untuk mengonfirmasi bahwa notifikasi telah disimpan.

Menyiapkan notifikasi menggunakan template melalui API

Siapkan notifikasi menggunakan API, seperti yang dijelaskan di bagian berikut.

Mengelola template notifikasi menggunakan API

Kelola template notifikasi menggunakan API, seperti yang dijelaskan di bagian berikut:

• Melihat semua template notifikasi menggunakan API
• Melihat template notifikasi menggunakan API
• Mengedit template notifikasi menggunakan API

Melihat semua template notifikasi menggunakan API

Anda dapat mencantumkan semua template notifikasi yang disediakan monetisasi dengan mengirimkan permintaan GET ke /mint/organizations/{org_name}/notification-email-templates. Contoh:

curl -H "Accept:application/json" -X GET \
  "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \
  -u email:password

Misalnya, berikut adalah template peristiwa yang memberi tahu developer tentang ketersediaan produk API baru:

{
    "createdDate" : 1376975394984,
    "htmlImage" : "<p>Dear ${developer.legalName} , ${developer.name} <br /> Introducing _________. For more details visit us at _________________</p>",
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "name" : "DEFAULT_NEW_PRODUCT_TEMPLATE",
    "orgId" : "myorg",
    "source" : "Mail Man Test",
    "subject" : "Notification of new product",
    "updatedDate" : 1376975394984
}

Melihat template notifikasi menggunakan API

Lihat template notifikasi dengan mengirim permintaan GET ke /mint/organizations/{org_name}/notification-email-templates/{template_id}, dengan {template_id} adalah ID template. Contoh:

curl -X GET "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b" \
  -H "Accept:application/json"  \
  -u email:password

Item dalam template yang diawali dengan $ adalah variabel. Untuk mengetahui informasi selengkapnya, lihat Menggunakan variabel dalam template notifikasi. Asumsikan bahwa variabel dalam notifikasi dievaluasi ke nilai berikut:

• ${developer.legalName}.XYZ company
• ${developer.name}.DEV1
• ${QUOTA_TYPE}.Transactions
• ${PERCENT}.90%
• ${QUOTA_UNIT}.Calls
• ${QUOTA_LIMIT}.100
• ${ratePlan.monetizationPackage.products.name}.X
• ${EXPIRY_DATE}.2016-09-30

Pesan notifikasi yang diberikan oleh template adalah:

    "Dear XYZ company, DEV1
    You have exceeded Transactions of 90% calls of 100 calls for X product. Your API calls will be blocked till 2016-09-30"

Mengedit template notifikasi menggunakan API

Edit template notifikasi dengan mengirimkan permintaan PUT ke /nint/organizations/{org_name}/notification-email-templates/{template_id}. Berikan konten template yang diubah dalam isi permintaan.

Saat menyesuaikan pesan dalam template notifikasi, Anda dapat menyertakan satu atau beberapa variabel. Untuk mengetahui informasi selengkapnya, lihat Menggunakan variabel dalam template notifikasi.

Misalnya, permintaan berikut mengedit konten notifikasi produk API baru:

curl -X PUT "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-email-templates/4d81ea64-d005-4010-b0a7-6ec8a5c3954b " \
  -H "Content-Type: application/json" \
  -d '{
    "id" : "4d81ea64-d005-4010-b0a7-6ec8a5c3954b",
    "htmlImage" : "<p>Exciting news, we have added a new product :${Product.name}. See details in <a href="${Product.url}">New Products</a> </p>",
    "name" : "NewProductNotification",
    "organization": {
    "id": "{org_name}"
    },
    "source" : "Mail Man Test ",
    "subject" : "New Product Available: ${Product.name}"
  }' \
  -u email:password

Mengelola kondisi dan tindakan notifikasi menggunakan API

Kelola kondisi dan tindakan notifikasi menggunakan API, seperti yang dijelaskan di bagian berikut.

• Membuat kondisi dan tindakan notifikasi menggunakan API
• Melihat kondisi dan tindakan notifikasi menggunakan API
• Mengedit kondisi dan tindakan notifikasi menggunakan API
• Menghapus kondisi dan tindakan notifikasi menggunakan API

Membuat kondisi dan tindakan notifikasi menggunakan API

Buat kondisi dan tindakan notifikasi yang menghasilkan notifikasi otomatis dengan mengirimkan permintaan POST ke /mint/organizations/{org_name}/notification-conditions.

Saat membuat permintaan, tentukan dalam isi permintaan kondisi yang menghasilkan notifikasi, dan tindakan yang akan diambil saat kondisi tersebut tercapai (seperti mengirim email notifikasi).

Anda menentukan detail kondisi notifikasi dengan menentukan satu atau beberapa nilai atribut. Lihat Properti konfigurasi untuk kondisi notifikasi untuk mengetahui daftar atribut. Untuk notifikasi peristiwa, kondisi dapat dipicu saat produk baru dipublikasikan.

Saat menentukan actions, referensikan template notifikasi yang berlaku. Lihat Properti konfigurasi untuk tindakan notifikasi untuk mengetahui daftar tindakan.

Misalnya, permintaan berikut menentukan bahwa saat atributnya adalah NEW_PRODUCT dan nilai atribut PUBLISHED adalah true, kirim notifikasi dalam template dengan ID 01191bf9-5fdd-45bf-8130-3f024694e63 (ini adalah DEFAULT_NEW_PRODUCT_TEMPLATE).

curl -X POST "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions" \
  -H "Content-Type:application/json"
  -d '{
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
      "attribute": "PUBLISHED",
      "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
  }' \
  -u email:password

Melihat kondisi dan tindakan notifikasi menggunakan API

Lihat kondisi dan tindakan notifikasi dengan mengirimkan permintaan GET ke organizations/{org_name}/notification-conditions/{condition_Id}, dengan {condition_Id} adalah ID kondisi. ID ditampilkan saat Anda membuat kondisi notifikasi. Contoh:

curl -X GET "https://api.enterprise.apigee.com /v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -H "Accept:application/json" \
  -u email:password

Berikut adalah contoh respons:

    {
    "actions" : [ {
    "actionAttribute" : "DEV_ID",
    "id" : "141ba00c-d7bd-4fef-b339-9d58b83255f4",
    "templateId" : "766aba4f-0f7a-4555-b48e-d707c48b8f4c",
    "value" : "ANY"
    }, {
    "actionAttribute" : "ORG_EMAIL",
    "id" : "21486ce1-4290-4a55-b415-165af3e93c9d",
    "templateId" : "efa4ce63-7c08-4876-984b-6878ec435994",
    "value" : "DEFAULT_LIMIT_NOTIFICATION_EMAIL"
    } ],
    "notificationCondition" : [ {
    "attribute" : "Balance",
    "id" : "2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4",
    "organization" : {
    ...
    },
    "value" : "< 0"
    } ]
    }

Mengedit kondisi dan tindakan notifikasi menggunakan API

Edit kondisi dan tindakan notifikasi dengan mengirim permintaan POST ke organizations/{org_name}/notification-conditions/{condition_Id}, dengan {condition_Id} adalah ID kondisi. ID ditampilkan saat Anda membuat kondisi notifikasi. Saat mengirimkan permintaan, tentukan dalam isi permintaan perubahan yang ingin Anda lakukan pada kondisi atau tindakan notifikasi.

Contoh:

   $ curl -H "Content-Type:application/json" -X POST -d \
    ' {
    "notificationCondition": [
    {
      "attribute": "NEW_PRODUCT"
    },
    {
    "attribute": "PUBLISHED",
    "value": "true"
    }
    ],
    "actions": [{
      "actionAttribute": "DEV_ID",
      "value": "ANY",
      "templateId": "01191bf9-5fdd-45bf-8130-3f024694e63"
    }]
    }' \
    "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4" \
  -u email:password

Menghapus kondisi dan tindakan notifikasi menggunakan API

Hapus kondisi notifikasi dengan mengirimkan permintaan DELETE ke organizations/{org_name}notification-conditions/{condition_Id}. Contoh:

curl -X DELETE "https://api.enterprise.apigee.com/v1/mint/organizations/{org_name}/notification-conditions/2d08d03f-8a54-4e75-bd6f-9c9da2f53fc4"  \
  -H "Accept:application/json"  \
  -u email:password

Properti konfigurasi untuk kondisi notifikasi

Properti konfigurasi berikut untuk kondisi notifikasi tersedia saat menggunakan API.

Properti konfigurasi untuk tindakan notifikasi

Properti konfigurasi berikut tersedia untuk tindakan notifikasi saat menggunakan API.

Menggunakan variabel dalam template notifikasi

Saat mengedit pesan dalam template notifikasi, Anda dapat menyertakan satu atau beberapa variabel, menggunakan Spring Expression Language (SpEL), untuk merepresentasikan nilai yang ditampilkan dalam objek Transaksi.

Tabel berikut meringkas variabel template notifikasi yang paling umum digunakan.

Menyesuaikan alamat email balas-ke Anda

Untuk monetisasi, alamat default noreply@apigee.com dikonfigurasi untuk digunakan dalam email pemberitahuan yang dikirim ke perusahaan dan developer. Hubungi Dukungan Apigee untuk mengonfigurasi nama dan alamat balasan kustom bagi organisasi Anda.