Bạn đang xem tài liệu về Apigee Edge.
Truy cập vào
tài liệu về Apigee X. thông tin
Mẫu thông báo là gì?
Tính năng kiếm tiền cung cấp một bộ mẫu xác định văn bản mẫu cho nhiều loại thông báo sự kiện. Bạn có thể tuỳ chỉnh bất kỳ mẫu nào trong số này để:
- Thông báo cho tất cả nhà phát triển về các sự kiện như sản phẩm mới, phiên bản mới của Điều khoản và điều kiện hoặc gói giá mới.
- Thông báo cho những nhà phát triển bị ảnh hưởng về các sự kiện như gói giá sửa đổi.
- Thông báo cho nhà cung cấp API về các sự kiện liên quan đến nhà phát triển, chẳng hạn như khi nhà phát triển đăng ký tài khoản hoặc khi nhà phát triển đăng ký gói giá.
- Thông báo cho tất cả quản trị viên của công ty về một sự kiện cụ thể.
Ngoài ra, bạn có thể tạo một webhook xác định trình xử lý gọi lại HTTP, sau đó định cấu hình điều kiện kích hoạt webhook, như mô tả trong phần Thiết lập thông báo bằng webhook.
Khám phá trang Thông báo
Truy cập vào trang Thông báo như mô tả bên dưới.
Edge
Cách truy cập vào trang Thông báo bằng giao diện người dùng Edge:
- Đăng nhập vào apigee.com/edge.
- Chọn Xuất bản > Kiếm tiền > Thông báo trong thanh điều hướng bên trái.
Trang Thông báo sẽ xuất hiện.
Như được làm nổi bật trong hình, trang Thông báo cho phép bạn:
- Mở rộng và thu gọn thông tin chi tiết về thông báo
- Chỉnh sửa thông tin chi tiết về thông báo và lưu tất cả nội dung chỉnh sửa
- Bật hoặc tắt thông báo
Classic Edge (Đám mây riêng tư)
Cách truy cập vào trang Thông báo bằng giao diện người dùng Edge cổ điển:
- Đăng nhập vào
http://ms-ip:9000
, trong đó ms-ip là địa chỉ IP hoặc tên DNS của nút Máy chủ quản lý. Chọn Quản trị > Thông báo trong thanh điều hướng trên cùng.
Trang Thông báo cho phép bạn:
Chỉnh sửa thông báo
Cách chỉnh sửa thông báo bằng giao diện người dùng:
- Truy cập vào trang Thông báo.
- Nhấp vào biểu tượng bên cạnh thông báo mà bạn muốn chỉnh sửa để mở rộng thông tin chi tiết.
- Chỉnh sửa các trường Chủ đề, Nội dung và Người nhận (nếu có) theo yêu cầu.
Để biết thông tin về các biến có thể được chỉ định trong mẫu thông báo, hãy xem phần Sử dụng biến trong mẫu thông báo.
Hãy tham khảo các phần sau để biết thêm thông tin về cách chỉnh sửa thông báo trong mỗi bộ nhớ:
- Bật thông báo bằng cách chọn hộp đánh dấu bên cạnh thông báo đó.
- Lặp lại các bước từ 2 đến 4 để chỉnh sửa các thông báo khác.
- Nhấp vào Lưu để lưu tất cả thay đổi.
Một thông báo sẽ xuất hiện để xác nhận rằng các thông báo đã được lưu. Thao tác lưu có thể mất vài phút.
Chỉnh sửa thông báo để thông báo cho tất cả nhà phát triển
Thông báo về các loại sự kiện mà bạn chọn trong mục Thông báo cho tất cả nhà phát triển sẽ được gửi đến tất cả nhà phát triển.
Thông báo được lên lịch chạy vào cuối ngày. Sau khi thông báo được gửi, các hộp đánh dấu sự kiện sẽ tự động bị xoá. Bạn phải chọn lại các loại sự kiện đó để lên lịch thông báo cho các loại sự kiện được liên kết.
Bảng sau đây liệt kê các thông báo dựa trên loại sự kiện trong phần Thông báo cho tất cả nhà phát triển. Để biết thêm thông tin, hãy xem bài viết Chỉnh sửa thông báo bằng giao diện người dùng.
Loại sự kiện | Kích hoạt | Ghi chú |
---|---|---|
Gói mới | Đã có gói API mới |
Thêm tên của từng gói mới (và các sản phẩm có trong từng gói) vào nội dung của mẫu email trong quá trình cập nhật. Bạn cũng có thể thêm đường liên kết đến trang web dành cho nhà phát triển hoặc bất kỳ trang web nào khác cung cấp thêm thông tin về thông báo. |
Sản phẩm mới | Sản phẩm API mới đã có |
Trong quá trình cập nhật, hãy thêm tên của từng sản phẩm mới vào phần nội dung của mẫu email. Bạn cũng có thể thêm đường liên kết đến cổng thông tin dành cho nhà phát triển hoặc bất kỳ trang web nào khác cung cấp thêm thông tin về thông báo đó. |
Thị trường mới/Phạm vi bao phủ | Các sản phẩm API mới có sẵn ở các thị trường địa lý cụ thể |
Thêm tên của từng thị trường mới và các sản phẩm liên quan vào nội dung của mẫu email trong phần cập nhật. Bạn cũng có thể thêm đường liên kết đến cổng thông tin dành cho nhà phát triển hoặc bất kỳ trang web nào khác cung cấp thêm thông tin về thông báo. |
Chỉnh sửa thông báo để thông báo cho nhà phát triển bị ảnh hưởng
Thông báo về các loại sự kiện mà bạn chọn trong phần Thông báo cho nhà phát triển bị ảnh hưởng chỉ được gửi đến những nhà phát triển bị ảnh hưởng bởi các loại sự kiện đó. Ví dụ: nếu bạn chọn sự kiện Gói giá đã sửa đổi, thì thông báo sẽ chỉ được gửi đến những nhà phát triển đã chấp nhận gói giá.
Bảng sau đây liệt kê các thông báo dựa trên loại sự kiện trong phần Thông báo cho nhà phát triển bị ảnh hưởng. Để biết thêm thông tin, hãy xem bài viết Chỉnh sửa thông báo bằng giao diện người dùng.
Loại sự kiện | Kích hoạt | Ghi chú |
---|---|---|
Điều khoản và điều kiện không được chấp nhận hoặc đã hết hạn | Bộ Điều khoản và điều kiện mới đã được xuất bản nhưng nhà phát triển chưa chấp nhận |
Thông báo sẽ được gửi 30 ngày, 7 ngày và 1 ngày trước khi Điều khoản và điều kiện mới có hiệu lực. |
Gói giá mới | Đã xuất bản gói giá mới |
Nếu gói giá là:
|
Gói giá đã sửa đổi | Đã có phiên bản mới hơn của gói giá bạn đã mua |
Chỉ những nhà phát triển mua phiên bản hiện tại mới nhận được thông báo. Thông báo này cho phép nhà phát triển xem xét phiên bản mới và chấm dứt hoặc chuyển đổi gói nếu họ không muốn chấp nhận mức giá mới. |
Gói giá đã hết hạn | Gói giá đã hết hạn và không có gói giá tiếp theo |
Thông báo này được gửi khi ban đầu bạn đặt gói giá là hết hạn, đồng thời sẽ có thêm thông báo được gửi 30, 7 và 1 ngày trước ngày hết hạn. Chúng tôi chỉ thông báo cho những nhà phát triển đã mua gói giá sắp hết hạn. |
Gói giá đã gia hạn | Gói thuê bao theo mức giá đã được gia hạn. |
Thông báo cho nhà phát triển rằng họ sẽ bị tính các khoản phí hiện hành. |
Đã vượt quá giới hạn tần suất | Đã vượt quá giới hạn gói giá |
Thông báo cho nhà phát triển rằng họ sẽ bị tính các khoản phí hiện hành. |
Gói giá Freemium đã hết hạn | Thời gian sử dụng miễn phí (được tính theo số giao dịch hoặc số ngày) đã hết |
Thời gian sử dụng miễn phí được xác định theo gói giá freemium của bạn. |
Chứng từ thanh toán đã được xuất bản |
Có giấy tờ thanh toán (chẳng hạn như hoá đơn) cho nhà phát triển. |
|
Nhà phát triển đăng ký gói giá mới | Nhà phát triển đăng ký một gói giá mới. |
Chỉnh sửa thông báo cho Nhà cung cấp API thông báo
Thông báo về các loại sự kiện mà bạn chọn trong phần Thông báo cho nhà cung cấp API sẽ được gửi đến nhà cung cấp API mà bạn chỉ định.
Bảng sau đây liệt kê các thông báo dựa trên loại sự kiện trong phần Nhà cung cấp API thông báo. Để biết thêm thông tin, hãy xem bài viết Chỉnh sửa thông báo bằng giao diện người dùng.
Loại sự kiện | Kích hoạt |
---|---|
Nhà phát triển mới đăng ký |
Nhà phát triển đã đăng ký một tài khoản. |
Nhà phát triển thêm ứng dụng |
Nhà phát triển đã tạo một ứng dụng mới. |
Đăng ký gói giá mới dành cho nhà phát triển |
Nhà phát triển đã đăng ký một gói giá. |
Thông tin tài chính thay đổi đối với nhà phát triển |
Nhà phát triển đã thay đổi thông tin tài chính, chẳng hạn như tên hoặc địa chỉ công ty của họ. |
Bật hoặc tắt thông báo
Cách bật hoặc tắt thông báo bằng giao diện người dùng:
- Truy cập vào trang Thông báo.
- Bật hoặc tắt thông báo bằng cách chọn hoặc bỏ chọn hộp kiểm tương ứng bên cạnh thông báo đó.
- Nhấp vào Lưu để lưu tất cả thay đổi.
Thao tác lưu có thể mất vài phút. Một thông báo sẽ xuất hiện để xác nhận rằng các thông báo đã được lưu.
Thiết lập thông báo bằng cách sử dụng mẫu thông qua API
Thiết lập thông báo bằng API như mô tả trong các phần sau.
Quản lý mẫu thông báo bằng API
Quản lý các mẫu thông báo bằng API, như được mô tả trong các phần sau:
Xem tất cả mẫu thông báo bằng API
Bạn có thể liệt kê tất cả các mẫu thông báo mà tính năng kiếm tiền cung cấp bằng cách đưa ra yêu cầu GET đến /mint/organizations/{org_name}/notification-email-templates
. Ví dụ:
curl -H "Accept:application/json" -X GET \ "https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-email-templates" \ -u email:password
Ví dụ: sau đây là mẫu sự kiện thông báo cho nhà phát triển về tình trạng có sẵn của một sản phẩm API mới:
{ "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 }
Xem mẫu thông báo bằng API
Xem mẫu thông báo bằng cách gửi yêu cầu GET tới /mint/organizations/{org_name}/notification-email-templates/{template_id}
, trong đó {template_id}
là mã nhận dạng của mẫu. Ví dụ:
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
Các mục trong những mẫu bắt đầu bằng $ là biến. Để biết thêm thông tin, hãy xem phần Sử dụng biến trong mẫu thông báo. Giả sử các biến trong thông báo đánh giá thành các giá trị sau:
${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
Thông báo do mẫu cung cấp sẽ là:
"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"
Chỉnh sửa mẫu thông báo bằng API
Chỉnh sửa mẫu thông báo bằng cách đưa ra yêu cầu PUT đến /nint/organizations/{org_name}/notification-email-templates/{template_id}
.
Cung cấp nội dung đã thay đổi của mẫu trong phần nội dung yêu cầu.
Khi tuỳ chỉnh thông báo trong mẫu thông báo, bạn có thể thêm một hoặc nhiều biến. Để biết thêm thông tin, hãy xem phần Sử dụng biến trong mẫu thông báo.
Ví dụ: yêu cầu sau đây sẽ chỉnh sửa nội dung của thông báo sản phẩm API mới:
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
Quản lý các thao tác và điều kiện về thông báo bằng API
Quản lý các điều kiện và hành động thông báo bằng API, như mô tả trong các phần sau.
- Tạo hành động và điều kiện thông báo bằng API
- Xem điều kiện và hành động thông báo bằng API
- Chỉnh sửa điều kiện và hành động của thông báo bằng API
- Xoá điều kiện và hành động thông báo bằng API
Tạo điều kiện và hành động thông báo bằng API
Tạo một điều kiện thông báo và hành động dẫn đến thông báo tự động bằng cách đưa ra yêu cầu POST đến /mint/organizations/{org_name}/notification-conditions
.
Khi bạn đưa ra yêu cầu, hãy chỉ định trong phần nội dung yêu cầu điều kiện dẫn đến thông báo và các hành động cần thực hiện khi đạt được điều kiện đó (chẳng hạn như gửi email thông báo).
Bạn xác định thông tin chi tiết về điều kiện thông báo bằng cách chỉ định một hoặc nhiều giá trị thuộc tính. Xem phần Thuộc tính cấu hình cho các điều kiện thông báo để biết danh sách các thuộc tính. Đối với thông báo sự kiện, điều kiện có thể được kích hoạt khi phát hành sản phẩm mới.
Khi xác định actions
, hãy tham chiếu mẫu thông báo hiện hành. Hãy xem phần Thuộc tính cấu hình cho hành động thông báo để biết danh sách các hành động.
Ví dụ: yêu cầu sau đây chỉ định rằng khi thuộc tính là NEW_PRODUCT
và giá trị của thuộc tính PUBLISHED
là true
, hãy gửi thông báo trong mẫu có mã nhận dạng 01191bf9-5fdd-45bf-8130-3f024694e63
(đây là 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
Xem điều kiện và hành động của thông báo bằng API
Xem điều kiện và hành động thông báo bằng cách đưa ra yêu cầu GET đến organizations/{org_name}/notification-conditions/{condition_Id}
, trong đó {condition_Id}
là mã nhận dạng của điều kiện. Mã này được trả về khi bạn tạo điều kiện thông báo. Ví dụ:
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
Sau đây là ví dụ về phản hồi:
{ "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" } ] }
Chỉnh sửa điều kiện và hành động của thông báo bằng API
Chỉnh sửa điều kiện và hành động thông báo bằng cách đưa ra yêu cầu POST đến organizations/{org_name}/notification-conditions/{condition_Id}
, trong đó {condition_Id}
là mã của điều kiện. Mã này được trả về khi bạn tạo điều kiện thông báo. Khi bạn đưa ra yêu cầu, hãy chỉ định trong phần nội dung yêu cầu những thay đổi mà bạn muốn thực hiện đối với điều kiện hoặc hành động thông báo.
Ví dụ:
$ 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
Xoá điều kiện và hành động thông báo bằng API
Xoá một điều kiện thông báo bằng cách đưa ra yêu cầu XOÁ đến organizations/{org_name}notification-conditions/{condition_Id}
. Ví dụ:
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
Thuộc tính cấu hình cho điều kiện thông báo
Các thuộc tính cấu hình sau đây cho điều kiện thông báo có sẵn khi sử dụng API.
Tên | Mô tả | Mặc định | Bắt buộc? |
---|---|---|---|
attribute |
Thông tin chi tiết về điều kiện thông báo. Bạn có thể chỉ định một hoặc nhiều thuộc tính để tinh chỉnh điều kiện thông báo. Giá trị có thể là một hoặc nhiều giá trị sau:
|
Không áp dụng | Có |
value |
Giá trị của thuộc tính. |
Không áp dụng | Không |
associatedCondition |
Tham chiếu đến một điều kiện liên quan. |
Không áp dụng | Không |
Thuộc tính cấu hình cho hành động thông báo
Các thuộc tính cấu hình sau đây có sẵn cho các hành động thông báo khi sử dụng API.
Tên | Mô tả | Mặc định | Bắt buộc? |
---|---|---|---|
actionAttribute |
Phương thức dùng để xác định người nhận thông báo. Giá trị có thể là một hoặc nhiều giá trị sau:
|
Không áp dụng | Có |
value |
Giá trị của thuộc tính hành động. Nếu Nếu bạn đặt Nếu bạn đặt |
Không áp dụng | Có |
templateID |
Mã của mẫu thông báo. Lưu ý: Tuỳ chọn này không hợp lệ nếu |
Không áp dụng | Có |
postURL |
Trình xử lý gọi lại cho webhook. Lưu ý: Bạn phải chọn tuỳ chọn này nếu đặt |
Không áp dụng | Có |
Sử dụng các biến trong mẫu thông báo
Khi chỉnh sửa thông báo trong mẫu thông báo, bạn có thể thêm một hoặc nhiều biến bằng cách sử dụng Ngôn ngữ biểu thức Spring (SpEL) để biểu thị các giá trị được trả về trong đối tượng Giao dịch.
Bảng sau đây tóm tắt các biến mẫu thông báo thường dùng nhất.
Biến | Mô tả |
---|---|
${application.name} |
Tên của một ứng dụng. |
${application.products.name} |
Tên của một sản phẩm có trong đơn đăng ký. |
${BALANCE} |
Số dư cho một hạn mức cụ thể. |
${developer.legalName} |
Tên công ty của nhà phát triển. |
${developer.name} |
Tên của nhà phát triển. |
${EXPIRY_DATE} |
Ngày hoặc giờ mà giới hạn hết hạn hoặc được đặt lại. |
${LONG_PERCENT} |
Tỷ lệ phần trăm của hạn mức đã đạt được theo mức sử dụng hiện tại, không có ký hiệu %. Ví dụ: 50 |
${PERCENT} |
Tỷ lệ phần trăm của hạn mức đã đạt được theo mức sử dụng hiện tại, có biểu tượng %. Ví dụ: 50%. |
${products.displayName} |
Tên hiển thị được xác định cho một sản phẩm. |
${QUOTA_TYPE} |
Loại hạn mức (số lượng giao dịch, hạn mức chi tiêu hoặc mức phí chịu). |
${QUOTA_UNIT} |
Đơn vị cơ bản của giới hạn: đơn vị tiền tệ (đối với giới hạn chi tiêu) hoặc lệnh gọi (đối với giới hạn giao dịch). |
${QUOTA_LIMIT} |
Số tiền giới hạn. |
${ratePlan.displayName} |
Tên hiển thị được xác định cho một gói giá. |
${ratePlan.endDate} |
Ngày nhà cung cấp API kết thúc một gói giá. |
${ratePlan.monetizationPackage.displayName} |
Tên của một gói API. |
${ratePlan.monetizationPackage.name} |
Tên của một Gói kiếm tiền. |
${ratePlan.monetizationPackage.products.displayName} |
Tên hiển thị được xác định cho một sản phẩm API. |
${ratePlan.monetizationPackage.products.name} |
Tên của một sản phẩm có trong gói Kiếm tiền. |
${ratePlan.startDate} |
Ngày tạo gói giá. |
${USAGE} |
Mức sử dụng hiện tại (tổng doanh thu hoặc phí hoặc số lượng). |
${USER} |
Tên người dùng. |
Tuỳ chỉnh địa chỉ email trả lời
Đối với hoạt động kiếm tiền, địa chỉ noreply@apigee.com mặc định được định cấu hình để sử dụng cho thông báo qua email được gửi đến các công ty và nhà phát triển. Hãy liên hệ với Nhóm hỗ trợ Apigee để định cấu hình tên và địa chỉ trả lời tuỳ chỉnh cho tổ chức của bạn.