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 teks contoh untuk berbagai jenis notifikasi peristiwa. Anda dapat menyesuaikan salah satu template ini untuk:

  • Beri tahu semua developer tentang peristiwa seperti produk baru, versi baru S&C, atau paket tarif baru.
  • Beri tahu developer yang terpengaruh tentang peristiwa seperti rencana tarif yang direvisi.
  • Beri tahu penyedia API tentang peristiwa terkait developer, seperti saat developer mendaftar untuk membuat akun atau saat developer mendaftar untuk paket tarif.
  • Memberi tahu semua administrator perusahaan tentang peristiwa tertentu.

Atau, Anda dapat membuat webhook yang menentukan pengendali 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.

Edge

Untuk mengakses halaman Notifications menggunakan Edge UI:

  1. Login ke apigee.com/edge.
  2. Pilih Publikasikan > Monetisasi > Notifikasi di menu navigasi sebelah kiri.

Halaman Notifikasi akan ditampilkan.

Seperti yang disorot dalam gambar, halaman Notifikasi memungkinkan Anda untuk:

Edge Klasik (Private Cloud)

Untuk mengakses halaman Notifications menggunakan UI Edge Klasik:

  1. Login ke http://ms-ip:9000, dengan ms-ip yang merupakan alamat IP atau nama DNS node Server Pengelolaan.

  2. Pilih Admin > Notifikasi di menu navigasi atas.

Halaman Notifikasi memungkinkan Anda:

Mengedit notifikasi

Untuk mengedit notifikasi menggunakan UI:

  1. Akses halaman Notifikasi.
  2. Klik di samping notifikasi yang ingin Anda edit untuk memperluas detailnya.
  3. Edit kolom Subjek, Isi, dan Penerima (jika tersedia), sebagaimana diperlukan.

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

    Lihat bagian berikut untuk informasi lebih lanjut tentang mengedit notifikasi di setiap kategori:

  4. Aktifkan pemberitahuan dengan memilih kotak centang di sebelahnya.
  5. Ulangi langkah 2 sampai 4 untuk mengedit notifikasi tambahan.
  6. Klik Simpan untuk menyimpan semua perubahan.

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

Mengedit notifikasi untuk Memberi tahu Semua Developer

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

Notifikasi dijadwalkan untuk berjalan pada penghujung hari. Setelah notifikasi terkirim, kotak centang peristiwa akan otomatis dihapus. Anda harus memilihnya lagi untuk menjadwalkan notifikasi untuk jenis peristiwa terkait.

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

Jenis Peristiwa Pemicu Catatan
Paket baru Paket API baru tersedia

Tambahkan nama setiap paket baru (dan produk yang terdapat dalam setiap paket) ke isi template email sebagai bagian dari pembaruan Anda. Anda juga dapat menambahkan link ke portal developer atau situs lain yang memberikan informasi selengkapnya tentang notifikasi ini.
Produk baru Produk API baru tersedia

Tambahkan nama setiap produk baru ke isi template email sebagai bagian dari pembaruan Anda. Anda juga dapat menambahkan link ke portal developer atau situs lain yang memberikan informasi selengkapnya tentang notifikasi ini.
Pasar/Cakupan Baru Produk API baru tersedia di pasar geografis tertentu

Tambahkan nama setiap pasar baru dan produk terkait ke isi template email sebagai bagian dari pembaruan Anda. Anda juga dapat menambahkan link ke portal developer atau situs lain yang memberikan informasi selengkapnya tentang notifikasi ini.

Mengedit notifikasi untuk Memberi tahu Developer yang Terpengaruh

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

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

Jenis Peristiwa Pemicu Catatan
S&C belum disetujui atau sudah tidak berlaku Serangkaian Persyaratan& Ketentuan baru telah dipublikasikan dan developer belum menyetujuinya

Notifikasi ini dikirim 30 hari, 7 hari, dan 1 hari sebelum Persyaratan& Ketentuan baru mulai berlaku.
Paket tarif baru Paket tarif baru dipublikasikan

Jika paket tarif adalah:

  • Standard Plan, semua developer akan diberi tahu.
  • Paket tarif kategori developer, hanya developer dalam kategori tersebut yang akan menerima notifikasi.
  • Paket tarif developer, hanya developer tertentu yang diberi tahu.
Paket tarif yang direvisi Versi paket tarif yang dibeli yang lebih baru tersedia

Hanya developer yang membeli versi saat ini yang akan diberi tahu. Notifikasi ini memungkinkan developer meninjau versi baru, dan menghentikan atau beralih paket jika tidak ingin menyetujui tarif baru.
Paket Tarif Kedaluwarsa Paket tarif sudah tidak berlaku tanpa paket tarif tindak lanjut

Notifikasi ini dikirim saat Anda pertama kali menetapkan masa berlaku paket tarif agar berakhir, dengan notifikasi tambahan yang dikirim 30, 7, dan 1 hari sebelum tanggal habis masa berlaku. Hanya developer yang telah membeli paket tarif hingga habis masa berlakunya yang akan menerima notifikasi.
Paket Tarif yang Diperpanjang Langganan paket tarif telah diperpanjang.

Beri tahu developer bahwa akan dikenakan biaya yang berlaku.
Batas Kapasitas Terlampaui Batas paket tarif telah terlampaui

Beri tahu developer bahwa akan dikenakan biaya yang berlaku.
Paket Tarif Freemium Habis Periode penggunaan gratis, yang diukur berdasarkan jumlah atau hari transaksi, telah habis

Periode penggunaan gratis ditentukan oleh paket tarif freemium Anda.
Dokumen Penagihan dipublikasikan

Dokumen penagihan (seperti invoice) untuk developer tersedia.
Developer mendaftar untuk Paket Tarif baru Developer mendaftar untuk paket tarif baru.

Mengedit notifikasi untuk Memberi tahu Penyedia API

Notifikasi untuk jenis peristiwa yang Anda pilih di bagian Beri tahu Penyedia API akan dikirim ke penyedia API yang Anda tentukan.

Tabel berikut berisi daftar notifikasi berdasarkan tipe kejadian di bagian Authorize API Provider. Untuk informasi selengkapnya, lihat Mengedit notifikasi menggunakan UI.

Jenis Peristiwa Pemicu
Pendaftaran Developer Baru

Developer telah mendaftar untuk membuat akun.
Developer Menambahkan Aplikasi

Developer telah membuat aplikasi baru.
Pendaftaran Developer untuk Paket Tarif Baru

Developer telah mendaftar untuk paket tarif.
Developer mengubah detail keuangan

Developer telah mengubah detail keuangan, seperti nama perusahaan atau alamat perusahaannya.

Mengaktifkan atau menonaktifkan notifikasi

Untuk mengaktifkan atau menonaktifkan notifikasi menggunakan UI:

  1. Akses halaman Notifikasi.
  2. Mengaktifkan atau menonaktifkan notifikasi dengan memilih atau membatalkan pilihan pada kotak centang di sampingnya.
  3. Klik Simpan untuk menyimpan semua perubahan.

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

Menyiapkan notifikasi menggunakan template menggunakan API

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

Mengelola template notifikasi menggunakan API

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

Melihat semua template notifikasi menggunakan API

Anda dapat mencantumkan semua template notifikasi yang disediakan monetisasi dengan mengajukan 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 ini 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 mengeluarkan permintaan GET ke /mint/organizations/{org_name}/notification-email-templates/{template_id}, dengan {template_id} sebagai 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-item dalam {i>template<i} yang dimulai dengan $ adalah variabel. Untuk informasi selengkapnya, lihat Menggunakan variabel dalam template notifikasi. Asumsikan bahwa variabel dalam notifikasi bernilai 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 mengeluarkan permintaan PUT ke /nint/organizations/{org_name}/notification-email-templates/{template_id}. Berikan konten template yang telah 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 isi 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

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

Saat membuat permintaan, tetapkan dalam isi permintaan kondisi yang menghasilkan notifikasi, dan tindakan yang akan diambil ketika kondisi ini 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 tersebut mungkin 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 jika atribut 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 notifikasi dan tindakan dengan mengeluarkan permintaan GET ke organizations/{org_name}/notification-conditions/{condition_Id}, dengan {condition_Id} sebagai ID kondisi. ID ini akan 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 responsnya:

    {
    "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 mengeluarkan permintaan POST ke organizations/{org_name}/notification-conditions/{condition_Id}, dengan {condition_Id} sebagai ID kondisinya. ID ini akan ditampilkan saat Anda membuat kondisi notifikasi. Saat mengajukan permintaan, tentukan perubahan yang ingin Anda buat pada kondisi atau tindakan notifikasi dalam isi permintaan.

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

Menghapus kondisi notifikasi dengan mengeluarkan permintaan HAPUS 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.

Nama Deskripsi Default Wajib diisi?
attribute

Detail kondisi notifikasi. Anda dapat menentukan satu atau beberapa atribut untuk menyaring kondisi notifikasi.

Nilainya bisa berupa satu atau beberapa hal berikut:

  • ADD_RATEPLAN
  • ADHOC_NOTIFY_DEVELOPERS
  • BILLING_DOCS_PUBLISHED
  • COMPANY_ACCEPTS_INVITATION
  • COMPANY_CANCELS_INVITATION
  • COMPANY_DECLINES_INVITATION
  • COMPANY_INVITES_DEVELOPER
  • CREATE_APPLICATION
  • CREATE_DEVELOPER
  • DATE
  • DEVELOPER_ACCEPTS_INVITATION
  • DEVELOPER_CANCELS_INVITATION
  • DEVELOPER_DECLINES_INVITATION
  • DEVELOPER_INVITES_COMPANY
  • EXPIRING_TNC
  • FeeExposure
  • FREEMIUM_USED_UP
  • NEW_PACKAGE
  • NEW_PRODUCT
  • PUBLISHED
  • RATEPLAN
  • RATEPLAN_ACCEPTED
  • RATEPLAN_ENDED
  • RATEPLAN_EXPIRED
  • RATEPLAN_RENEWED
  • RATEPLAN_REVISION
  • Transactions
  • UPDATE_DEVELOPER
  • UsageTarget (hanya berlaku untuk mengonfigurasi webhook)
 T/A Ya
value

Nilai atribut.

 T/A Tidak
associatedCondition

Referensi ke kondisi terkait.

 T/A Tidak

Properti konfigurasi untuk tindakan notifikasi

Properti konfigurasi berikut tersedia untuk tindakan notifikasi saat menggunakan API.

Nama Deskripsi Default Wajib diisi?
actionAttribute

Metode yang digunakan untuk mengidentifikasi penerima notifikasi. Nilainya bisa berupa satu atau beberapa hal berikut:

  • ORG_EMAIL. Penerima notifikasi diidentifikasi berdasarkan alamat email.
  • DEV_ID. Penerima notifikasi diidentifikasi berdasarkan ID developer (alamat email).
  • COMPANY_ADMINS. Notifikasi dikirim ke semua administrator perusahaan terlepas dari nilainya yang ditetapkan. Perhatikan bahwa administrator perusahaan berbeda dengan administrator organisasi.
  • WEBHOOK. Informasi penerima notifikasi dikirim ke pengendali callback webhook. Lihat Menyiapkan notifikasi menggunakan webhook.
 T/A Ya
value

Nilai atribut tindakan.

Jika actionAttribute disetel ke ORG_EMAIL atau DEV_ID, nilai ANY akan mengirimkan notifikasi ke semua penerima yang berlaku, misalnya, semua alamat ORG_EMAIL atau DEV_ID.

Jika actionAttribute ditetapkan ke WEBHOOK, tetapkan nilai ini ke ID webhook.

Jika actionAttribute ditetapkan ke COMPANY_ADMINS, nilai ini akan diabaikan; notifikasi akan dikirim ke semua administrator perusahaan.

 T/A Ya
templateID

ID template notifikasi.

Catatan: Opsi ini tidak valid jika actionAttribute ditetapkan ke WEBHOOK.

 T/A Ya
postURL

Pengendali callback untuk webhook.

Catatan: Opsi ini diperlukan jika actionAttribute ditetapkan ke WEBHOOK. Opsi ini tidak valid jika nilainya ditetapkan ke ORG_EMAIL, DEV_ID, atau COMPANY_ADMINS.

 T/A Ya

Menggunakan variabel dalam template notifikasi

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

Tabel berikut merangkum variabel template notifikasi yang paling umum digunakan.

Variabel Deskripsi
${application.name}

Nama aplikasi.
${application.products.name} Nama produk yang disertakan dalam aplikasi.
${BALANCE} Saldo untuk kuota tertentu.
${developer.legalName}

Nama perusahaan developer.
${developer.name}

Nama developer.
${EXPIRY_DATE}

Tanggal atau waktu batas berakhir atau direset.
${LONG_PERCENT} Persentase batas yang dicapai menurut penggunaan saat ini, tanpa simbol %. Misalnya, 50
${PERCENT}

Persentase batas yang dicapai menurut penggunaan saat ini, dengan simbol %. Misalnya, 50%.
${products.displayName} Nama tampilan yang ditentukan untuk produk.
${QUOTA_TYPE}

Jenis batas (volume transaksi, batas pembelanjaan, atau eksposur biaya).
${QUOTA_UNIT}

Unit dasar untuk batas: mata uang (untuk batas pembelanjaan), atau panggilan (untuk batas transaksi).
${QUOTA_LIMIT}

Jumlah batas.
${ratePlan.displayName} Nama tampilan yang ditentukan untuk paket tarif.
${ratePlan.endDate} Tanggal penyedia API mengakhiri paket tarif.
${ratePlan.monetizationPackage.displayName}

Nama paket API.
${ratePlan.monetizationPackage.name} Nama paket Monetisasi.
${ratePlan.monetizationPackage.products.displayName}

Nama tampilan yang ditentukan untuk produk API.
${ratePlan.monetizationPackage.products.name} Nama produk yang disertakan dalam paket Monetisasi.
${ratePlan.startDate} Tanggal pembuatan paket tarif.
${USAGE} Penggunaan saat ini (total pendapatan atau tagihan, atau volume).
${USER}

Nama pengguna.

Menyesuaikan alamat email balas-ke Anda

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