Menyiapkan notifikasi menggunakan template notifikasi

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

Apa itu template notifikasi?

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

  • Memberi tahu semua developer tentang acara seperti produk baru, Persyaratan & Ketentuan versi baru, atau paket tarif.
  • Memberi tahu developer yang terpengaruh tentang peristiwa seperti revisi paket tarif.
  • Memberi tahu penyedia API, tentang peristiwa terkait developer, seperti ketika developer mendaftar untuk 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 Notifikasi menggunakan UI Edge:

  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 Notifications memungkinkan Anda untuk:

Edge Klasik (Private Cloud)

Untuk mengakses halaman Notifications menggunakan UI Classic Edge:

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

  2. Pilih Admin > Notifikasi di menu navigasi atas.

Halaman Notifikasi memungkinkan Anda untuk:

Mengedit notifikasi

Untuk mengedit notifikasi menggunakan UI:

  1. Mengakses halaman Notifikasi.
  2. Klik di samping notifikasi yang ingin Anda edit untuk memperluas detailnya.
  3. Edit kolom Subjek, Isi, dan Penerima (jika ada), sesuai yang wajib diisi.

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

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

  4. Aktifkan notifikasi dengan memilih kotak centang di sebelahnya.
  5. Ulangi langkah 2 hingga 4 untuk mengedit notifikasi tambahan.
  6. Klik Save 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 acara yang Anda pilih di bagian Beri Tahu Semua Developer dikirim ke semua developer.

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

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

Jenis Peristiwa Pemicu Catatan
Paket baru Paket API baru telah tersedia

Tambahkan nama setiap paket baru (dan produk yang terkandung dalam setiap paket) ke {i>template<i} email sebagai bagian dari pembaruan. Anda juga dapat menambahkan tautan ke portal developer Anda atau situs lain yang memberikan informasi selengkapnya tentang notifikasi.
Produk baru Produk API baru telah tersedia

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

Tambahkan nama setiap pasar baru dan produk terkait ke isi email {i>template <i}sebagai bagian dari pembaruan Anda. Anda juga dapat menambahkan link ke portal developer atau situs lain yang memberikan informasi lebih lanjut tentang notifikasi tersebut.

Mengedit notifikasi untuk Memberi Tahu Developer yang Terpengaruh

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

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

Jenis Peristiwa Pemicu Catatan
Persyaratan dan Ketentuan tidak diterima atau sudah tidak berlaku Kumpulan Persyaratan&Ketentuan baru telah dipublikasikan dan developer belum menyetujuinya

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

Jika paket tarif adalah:

  • Paket Standard, 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 akan diberi tahu.
Paket tarif yang direvisi Versi baru paket tarif yang dibeli telah tersedia

Hanya developer yang membeli versi saat ini yang akan diberi tahu. Tujuan notifikasi memungkinkan developer meninjau versi baru, dan menghentikan atau mengganti jika mereka tidak ingin menerima tarif baru.
Paket Tarif sudah tidak berlaku Masa berlaku paket tarif habis tanpa paket tarif tindak lanjut

Notifikasi ini dikirim saat Anda awalnya menetapkan masa berlaku paket tarif ini, dengan notifikasi tambahan yang dikirim 30, 7, dan 1 hari sebelum tanggal habis masa berlaku. Hanya yang developer yang telah membeli paket tarif yang telah habis masa berlakunya akan diberi tahu.
Paket Tarif Diperpanjang Langganan paket tarif telah diperpanjang.

Memberi tahu developer bahwa akan dikenakan biaya yang berlaku.
Batas Jumlah Terlampaui Batas paket tarif telah terlampaui

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

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

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

Mengedit notifikasi untuk Memberi Tahu Penyedia API

Notifikasi untuk jenis peristiwa yang Anda pilih di Penyedia Notifikasi API dikirim ke penyedia API yang Anda tentukan.

Tabel berikut mencantumkan notifikasi berdasarkan jenis peristiwa di bagian Penyedia Notifikasi API. Untuk mengetahui 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.
Developer Mendaftar ke Paket Tarif Baru

Developer telah mendaftar untuk paket tarif.
Developer mengubah detail keuangan

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

Mengaktifkan atau menonaktifkan notifikasi

Untuk mengaktifkan atau menonaktifkan notifikasi menggunakan UI:

  1. Mengakses halaman Notifikasi.
  2. Mengaktifkan atau menonaktifkan pemberitahuan dengan memilih atau membatalkan pilihan, masing-masing, kotak centang di sebelahnya.
  3. Klik Save 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 yang 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 yang menggunakan API

Anda dapat mencantumkan semua template notifikasi yang disediakan monetisasi dengan menerbitkan GET permintaan 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 mengeluarkan 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 informasi selengkapnya, lihat Menggunakan variabel dalam template notifikasi. Asumsikan bahwa variabel dalam notifikasi mengevaluasi 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 disediakan 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}. Masukkan konten template yang telah diubah di isi permintaan.

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

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 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, tentukan dalam isi permintaan kondisi yang akan menghasilkan notifikasi, dan tindakan yang akan diambil saat kondisi itu tercapai (seperti mengirim email notifikasi).

Anda mendefinisikan detail kondisi notifikasi dengan menetapkan satu atau beberapa atribut masing-masing. Lihat Properti konfigurasi untuk kondisi notifikasi untuk mengetahui daftar atribut. Untuk notifikasi peristiwa, kondisi tersebut mungkin dipicu saat produk baru dipublikasikan.

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

Misalnya, permintaan berikut menetapkan bahwa ketika atribut NEW_PRODUCT dan nilai atribut PUBLISHED adalah true, kirim notifikasi di 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 mengeluarkan permintaan GET ke organizations/{org_name}/notification-conditions/{condition_Id}, dengan {condition_Id} adalah 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 ini 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} adalah ID kondisi. ID ini akan ditampilkan saat Anda membuat kondisi notifikasi. Saat mengajukan permintaan, sebutkan dalam isi permintaan perubahan yang yang ingin Anda buat 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 mengeluarkan 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 ini.

Nama Deskripsi Default Wajib?
attribute

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

Nilainya bisa satu atau beberapa dari yang 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 (valid 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?
actionAttribute

Metode yang digunakan untuk mengidentifikasi penerima notifikasi. Nilainya bisa 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 nilai yang ditetapkan. Perhatikan bahwa administrator perusahaan berbeda dengan administrator organisasi.
  • WEBHOOK. Informasi penerima notifikasi dikirim ke webhook pengendali callback. Lihat Menyiapkan notifikasi menggunakan webhook.
 T/A Ya
value

Nilai atribut tindakan.

Jika actionAttribute disetel ke ORG_EMAIL atau DEV_ID, nilai ANY akan mengirim notifikasi ke setiap yang berlaku penerima, misalnya, 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 terkirim kepada 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 nilai disetel 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 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 yang ditentukan.
${developer.legalName}

Nama perusahaan developer.
${developer.name}

Nama developer.
${EXPIRY_DATE}

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

Persentase batas yang dicapai berdasarkan 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 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 ditetapkan untuk produk API.
${ratePlan.monetizationPackage.products.name} Nama produk yang disertakan dalam paket Monetisasi.
${ratePlan.startDate} Tanggal pembuatan rencana tarif.
${USAGE} Penggunaan saat ini (total pendapatan atau tagihan, atau volume).
${USER}

Nama pengguna.