此页面由 Cloud Translation API 翻译。

测试通知设置

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档。信息

简介

变现服务提供了一组 API，可用于测试通知设置。具体来说，您可以：

测试 webhook 的执行，以确保发送通知
查看和重新处理已发送的通知

测试 webhook

webhook 定义了由事件触发的 HTTP 回调处理程序。如需了解如何设置网络钩子，请参阅使用网络钩子设置通知。

您可以执行以下步骤来测试网络钩子：

查看可用的 webhook 通知触发器类型
查看 webhook 通知测试的请求载荷示例
测试 webhook 的执行情况

查看可用的 webhook 通知触发器类型

通过向以下资源发出 GET 请求，查看可用的 webhook 通知触发器类型：

/organizations/{org_name}/webhooks/{webhook_id}/test/{developer_email_or_id}/{app_id}/{product_id}/{rateplan_id}

其中：

{org_name} 指定组织的名称。
{webhook_id} 指定网络钩子的 ID。如需查看网络钩子列表并获取网络钩子 ID，请参阅使用 API 查看所有网络钩子。
{developer_email_or_id} 用于指定开发者的 ID。如需查看开发者列表，请参阅列出开发者。
{app_id} 指定您要测试 webhook 触发条件的应用的 ID。如需列出组织中的应用 ID，请参阅列出组织中的应用 ID。
{product_id} 指定您要测试网络钩子触发操作的 API 产品的 ID。要查看某个组织的 API 产品列表，请参阅列出 API 产品。
{rateplan_id} 指定您要测试网络钩子触发操作的费率方案的 ID。费率方案 ID 与显示名称不同。如需查看费率方案详细信息（包括 ID），请参阅探索费率方案页面。

例如，以下 c网址调用将返回 RATEPLANQUOTAUSAGE 作为网络钩子通知触发器类型。

curl -H "Content-Type: application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/0a07eb1f-f485-4539-8beb-01be449699b3/test/joe@example.com/e759c119-510c-49a8-886c-f184091944bd/myproduct/mypackage_anrp" \ 
-u email:password

以下提供了一个响应示例：

[
  "RATEPLANQUOTAUSAGE"
]

接下来，您需要确定网络钩子通知触发器类型的请求载荷的架构。

查看 webhook 通知测试的示例请求载荷

通过向以下资源发出 GET 请求，查看可用于 webhook 通知测试的示例请求载荷：

/organizations/{org_name}/webhooks/{webhook_id}/test/{developer_email_or_id}/{app_id}/{product_id}/{rateplan_id}/{trigger_type}

其中：

{org_name} 指定组织的名称。
{webhook_id} 指定网络钩子的 ID。如需查看网络钩子列表并获取网络钩子 ID，请参阅使用 API 查看所有网络钩子。
{developer_email_or_id} 用于指定开发者的 ID。如需查看开发者列表，请参阅列出开发者。
{app_id} 指定您要测试 webhook 触发条件的应用的 ID。如需列出组织中的应用 ID，请参阅列出组织中的应用 ID。
{product_id} 指定您要测试网络钩子触发操作的 API 产品的 ID。要查看某个组织的 API 产品列表，请参阅列出 API 产品。
{rateplan_id} 指定您要测试网络钩子触发操作的费率方案的 ID。费率方案 ID 与显示名称不同。如需查看费率方案详细信息（包括 ID），请参阅探索费率方案页面。
{trigger_type} 指定上一步中返回的网络钩子通知触发器类型的名称（列出可用的网络钩子通知触发器类型）。

例如，以下 c网址调用会返回 RATEPLANQUOTAUSAGE 网络钩子通知触发器类型的示例请求载荷：

curl -H "Content-Type: application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/0a07eb1f-f485-4539-8beb-01be449699b3/test/joe@example.com/e759c119-510c-49a8-886c-f184091944bd/myproduct/mypackage_anrp/RATEPLANQUOTAUSAGE" \ 
-u email:password

以下示例提供了一个请求载荷示例：

{
   "eventTriggerReason": "RATEPLANQUOTAUSAGE",
   "properties": [
   {
        "key": "quotaPercentUsed",
        "value": "100"
   }
   ]
}

接下来，您可以根据需要修改返回的示例请求载荷，并使用它来测试 webhook 的执行情况。

测试 webhook 的执行

通过向以下资源发出 POST 请求来测试 webhook 的执行情况：

/organizations/{org_name}/webhooks/{webhook_id}/test/{developer_email_or_id}/{app_id}/{product_id}/{rateplan_id}.

其中：

{org_name} 指定组织的名称。
{webhook_id} 指定网络钩子的 ID。如需查看网络钩子列表并获取网络钩子 ID，请参阅使用 API 查看所有网络钩子。
{developer_email_or_id} 用于指定开发者的 ID。如需查看开发者列表，请参阅列出开发者。
{app_id} 指定您要测试 webhook 触发条件的应用的 ID。如需列出组织中的应用 ID，请参阅列出组织中的应用 ID。
{product_id} 指定您要测试网络钩子触发操作的 API 产品的 ID。要查看某个组织的 API 产品列表，请参阅列出 API 产品。
{rateplan_id} 指定您要测试网络钩子触发操作的费率方案的 ID。费率方案 ID 与显示名称不同。如需查看费率方案详细信息（包括 ID），请参阅探索费率方案页面。

根据需要修改上一步中返回的示例请求载荷（查看 webhook 通知测试的示例请求载荷），并在请求载荷中传递它。

例如，以下 c网址调用会测试指定 webhook 的执行情况：

curl -H "Content-Type: application/json" -X POST -d \
'{
  "eventTriggerReason": "RATEPLANQUOTAUSAGE",
  "properties": [
    {
      "key": "quotaPercentUsed",
      "value": "120"
    }
  ]
}' \
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/webhooks/0a07eb1f-f485-4539-8beb-01be449699b3/test/joe@example.com/e759c119-510c-49a8-886c-f184091944bd/myproduct/mypackage_anrp" \ 
-u email:password

下面提供了一个响应示例，表明通知已成功发送到 webhook：

{
  "original": {
    "createdDate": 1463619959930,
    "createdTimeStamp": 1463616000000,
    "notificationType": "WEBHOOK",
    "orgId": "myorg",
    "rawMessage": "{\"orgName\":\"myorg\",\"developerEmail\":\"joe@example.com\",\"developerFirstName\":\"Joe\",\"developerLastName\":\"Smith\",\"applicationName\":\"myapp\",\"packageName\":\"MyPackage\",\"packageId\":\"mypackage\",\"ratePlanId\":\"mypackage_anrp\",\"ratePlanName\":\"anrp\",\"ratePlanType\":\"STANDARD\",\"developerRatePlanQuotaTarget\":200,\"quotaPercentUsed\":\"120\",\"ratePlanStartDate\":1463616000000,\"ratePlanEndDate\":null,\"nextBillingCycleStartDate\":null,\"products\":[\"myproduct\"],\"developerCustomAttributes\":[]\"triggerTime\":1463619959929,\"triggerReason\":\"RATEPLANQUOTAUSAGE\",\"developerQuotaResetDate\":null}",
    "retryCount": 0,
    "retryStatuses": [],
    "source": "MailTo: [36112720-1304-4e0b-9b17-991f5e121ebb], Org: [myorg], TransactionId: [], LimitId: [], Key: []",
    "toEmail": "http://123.45.67.89/webhook",
    "updatedDate": 1463619959930
  },
  "raw": "This is the response",
  "responseCode": 200,
  "status": "NOTIFICATION_SENT"
}

查看和重新处理通知

利用创收功能，您可以设置由特定事件触发的通知。如需了解如何设置通知，请参阅设置通知

对于发送的每条通知，都会存储以下信息：

重试次数
响应代码
响应标头
响应内容（仅前 1000 个字符）

您可以通过执行以下步骤来查看和重新处理通知：

查看已发送的通知
查看通知的详细信息
重新处理通知

查看已发送的通知

通过向以下资源发出 GET 请求，查看为组织发送的通知：

/organizations/{org_name}/notification-service-items

其中 {org_name} 指定组织的名称。

（可选）您可以指定以下一个或多个查询参数，以过滤响应中返回的通知列表：

查询参数	说明
`startdate`	格式为 `YYYY-MM-DD HH:mm:ss` 的开始日期。
`enddate`	格式为 `YYYY-MM-DD HH:mm:ss` 的结束日期。
`status`	通知的状态。有效值包括： `BLANK_MESSAGE` `DUPLICATE` `FAILED` `NOTIFICATION_SENT` `OPT_OUT` `QUEUED` `TEMPLATE_NOT_FOUND`
`toemail`	接收通知的电子邮件 ID 或 webhook。

最多返回 1000 条通知。

在响应中，hasMoreItems 标志指示指定列表中的通知数量是否超过 1000。如果 hasMoreItems 为 true（表示通知数量过多，无法显示），并且您希望查看其余通知，则需要优化查询参数过滤条件，使每个请求处理的通知数量更少。例如，您可以使用几个较小的日期范围发出多个请求，或者返回仅包含特定状态值的通知。

例如，以下 c网址调用列出了指定日期范围内针对指定 webhook 的 FAILED 通知：

curl -H "Content-Type: application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-service-items?enddate=2016-05-19 12:00:00&startdate=2016-05-18 12:00:00&status=FAILED&toemail=http://123.45.6789:8000/webhook" \ 
-u email:password

以下提供了一个响应示例：

 {
   "hasMoreItems": false,
   "notifications": [
   { 
      "createdDate": 1463626865974, 
      "createdTimeStamp": 1463616000000, 
      "id": "9d87c6ea-1394-495b-bfb7-1d2e7ef3f837", 
      "notificationType": "WEBHOOK", 
      "orgId": "Org_d40f6c2e-1d6d-11e6-a4ed-af8444f24e4f", 
      "rawMessage": "{\"orgName\":\"Org_d40f6c2e-1d6d-11e6-a4ed-af8444f24e4f\",\"developerEmail\":\"joe@example.com\",\"developerFirstName\":\"Joe\",\"developerLastName\":\"Smith\",\"applicationName\":\"MyApp\",
\"packageName\":\"test-package\",\"packageId\":\"myorg@@@test-package-9ubo\",\"ratePlanId\":\"myorg@@@test-package-9ubo_anrp\",\"ratePlanName\":\"anrp\",\"ratePlanType\":\"STANDARD\",
\"developerRatePlanQuotaTarget\":10,\"quotaPercentUsed\":\"20\",\"ratePlanStartDate\":1463616000000,\"ratePlanEndDate\":null,\"nextBillingCycleStartDate\":1464739200000,\"products\":[\"product1\"],
\"developerCustomAttributes\":[],\"triggerTime\":1463626865907,\"triggerReason\":\"RatePlanQuotaUsage\",\"developerQuotaResetDate\":\"1464810145000\"}", 
      "retryCount": 3, 
      "retryStatuses": [ 
      { 
         "responseCode": 500, 
         "responseMessage": "{\"Headers\":\"[{\"name\":\"Content-length\",\"buffer\":{\"empty\":false,\"full\":false},\"valuePos\":15,\"value\":\"20\",\"elements\":[{\"name\":\"20\",\"value\":null,\"parameters\":[],\"parameterCount\":0}]},{\"name\":\"Date\",\"buffer\":{\"empty\":false,\"full\":false},\"valuePos\":5,\"value\":\"Thu, 19 May 2016 03:01:09 GMT\",\"elements\":[{\"name\":\"Thu\",\"value\":null,\"parameters\":[],\"parameterCount\":0},{\"name\":\"19 May 2016 03:01:09 GMT\",\"value\":null,\"parameters\":[],\"parameterCount\":0}]}]\",\"StatusCode\":\"500\",\"Content : \":\"This is the response\"}", 
         "retriedAt": 1463626869184,
         "retryAttempt": 1 
      }, 
      { 
         "responseCode": 500, 
         "responseMessage": "{\"Headers\":\"[{\"name\":\"Content-length\",\"buffer\":{\"empty\":false,\"full\":false},\"valuePos\":15,\"value\":\"20\",\"elements\":[{\"name\":\"20\",\"value\":null,\"parameters\":[],\"parameterCount\":0}]},{\"name\":\"Date\",\"buffer\":{\"empty\":false,\"full\":false},\"valuePos\":5,\"value\":\"Thu, 19 May 2016 03:01:09 GMT\",\"elements\":[{\"name\":\"Thu\",\"value\":null,\"parameters\":[],\"parameterCount\":0},{\"name\":\"19 May 2016 03:01:09 GMT\",\"value\":null,\"parameters\":[],\"parameterCount\":0}]}]\",\"StatusCode\":\"500\",\"Content : \":\"This is the response\"}", 
         "retriedAt": 1463626869318, 
         "retryAttempt": 2 
      }, 
      { 
         "responseCode": 500, 
         "responseMessage": "{\"Headers\":\"[{\"name\":\"Content-length\",\"buffer\":{\"empty\":false,\"full\":false},\"valuePos\":15,\"value\":\"20\",\"elements\":[{\"name\":\"20\",\"value\":null,\"parameters\":[],\"parameterCount\":0}]},{\"name\":\"Date\",\"buffer\":{\"empty\":false,\"full\":false},\"valuePos\":5,\"value\":\"Thu, 19 May 2016 03:01:09 GMT\",\"elements\":[{\"name\":\"Thu\",\"value\":null,\"parameters\":[],\"parameterCount\":0},{\"name\":\"19 May 2016 03:01:09 GMT\",\"value\":null,\"parameters\":[],\"parameterCount\":0}]}]\",\"StatusCode\":\"500\",\"Content : \":\"This is the response\"}", 
         "retriedAt": 1463626869378, 
         "retryAttempt": 3 
      } 
      ], 
      "source": "MailTo: [6c3cde37-a8f1-4077-adbe-e9f6605a7299], Org: [myorg], TransactionId: [b8d763be-7185-450d-b421-df38c870fabd], LimitId: [RatePlan-Limit:myorg@@@test-package-9ubo_anrp], Key: [myorg@@@kjGSxEGtZeekBEyI~myorg@@@test-package-9ubo_anrp~Transactions~Calls~20]", 
      "status": "FAILED", 
      "toEmail": "http://123.45.67.89:8000/webhook", 
      "updatedDate": 1463626865974 
   } 
   ] 
}

查看通知的详细信息

通过向以下资源发出 GET 请求，查看特定通知的详细信息：

/organizations/{org_name}/notification-service-items/{notification_id}

其中：

{org_name} 指定组织的名称。
{notification_id} 指定您要显示其详细信息的通知的 ID。在查看已发送的通知时，您可以从响应输出中获取通知 ID。

例如，以下 c网址调用列出了 ID 为 4b3dfadf-3a96-4a92-9512-1feff22f74f3 的通知的详细信息：

curl -H "Content-Type: application/json" -X GET \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-service-items/faa8e6a8-754e-40e8-9e0c-4dee6c9aca23" \ 
-u email:password

以下提供了一个响应示例：

 {
  "createdDate": 1461062402871,
  "createdTimeStamp": 1461024000000,
  "id": "faa8e6a8-754e-40e8-9e0c-4dee6c9aca23",
  "notificationType": "WEBHOOK",
  "orgId": "myorg",
  "rawMessage": "{\"orgName\":\"myorg\",\"developerEmail\":\"joe@example.com\",\"developerFirstName\":\"Joe\",\"developerLastName\":\"Smith\",\"applicationName\":\"myapp\",\"packageName\":\"mypackage\",\"ratePlanName\":\"anrp\",\"ratePlanType\":\"STANDARD\",\"developerRatePlanQuotaTarget\":54000,\"quotaPercentUsed\":\"1\",\"ratePlanStartDate\":1460419200000,\"ratePlanEndDate\":null,\"nextBillingCycleStartDate\":null,\"products\":[\"myproduct\"],\"developerCustomAttributes\":[],\"triggerTime\":1461062395966,\"triggerReason\":\"RatePlanQuotaUsage\"}",
  "retryCount": 0,
  "retryStatuses": [],
  "source": "MailTo: [c9e42fcd-9632-4376-b92d-0fa27f178a3b], Org: [myorg], TransactionId: [0352e568-2724-42d9-a264-1b62586d5948], LimitId: [RatePlan-Limit:amyorg@@@mypackage-a0y9_anrp], Key: [myorg@@@PPXsQbkyO1bBhQOh~myorg@@@mypackage-a0y9_anrp~Transactions~Calls~1]",
  "status": "NOTIFICATION_SENT",
  "toEmail": "http://123.45.67.89:8000/webhook",
  "updatedDate": 1461062402871
}

重新处理通知

通过向以下资源发出 POST 请求来重新处理通知：

/organizations/{org_name}/notification-service-items/{notification_id}/reprocess

其中：

{org_name} 指定组织的名称。
{notification_id} 指定您要显示其详细信息的通知项的 ID。在查看已发送的通知时，您可以从响应输出中获取通知 ID。

例如，以下 c网址调用重新处理 ID 为 4b3dfadf-3a96-4a92-9512-1feff22f74f3 的通知：

curl -H "Content-Type: application/json" -X POST \ 
"https://api.enterprise.apigee.com/v1/mint/organizations/myorg/notification-service-items/faa8e6a8-754e-40e8-9e0c-4dee6c9aca23/reprocess" \ 
-u email:password

{
  "createdDate": 1461062402871,
  "createdTimeStamp": 1461024000000,
  "id": "faa8e6a8-754e-40e8-9e0c-4dee6c9aca23",
  "notificationType": "WEBHOOK",
  "orgId": "myorg",
  "rawMessage": "{\"orgName\":\"myorg\",\"developerEmail\":\"joe@example.com\",\"developerFirstName\":\"Joe\",\"developerLastName\":\"Smith\",\"applicationName\":\"myapp\",\"packageName\":\"mypackage\",\"ratePlanName\":\"anrp\",\"ratePlanType\":\"STANDARD\",\"developerRatePlanQuotaTarget\":54000,\"quotaPercentUsed\":\"1\",\"ratePlanStartDate\":1460419200000,\"ratePlanEndDate\":null,\"nextBillingCycleStartDate\":null,\"products\":[\"myproduct\"],\"developerCustomAttributes\":[],\"triggerTime\":1461062395966,\"triggerReason\":\"RatePlanQuotaUsage\"}",
  "retryCount": 0,
  "retryStatuses": [
    {
      "responseCode": 200,
      "responseMessage": "{\"Headers\":\"[{\"name\":\"Accept-Encoding\",\"buffer\":{\"full\":false,\"empty\":false},\"valuePos\":16,\"elements\":[{\"name\":\"gzip\",\"value\":null,\"parameters\":[],\"parameterCount\":0},{\"name\":\"deflate\",\"value\":null,\"parameters\":[],\"parameterCount\":0}],\"value\":\"gzip,deflate\"},{\"name\":\"Content-Type\",\"buffer\":{\"full\":false,\"empty\":false},\"valuePos\":13,\"elements\":[{\"name\":\"application/json\",\"value\":null,\"parameters\":[{\"name\":\"charset\",\"value\":\"UTF-8\"}],\"parameterCount\":1}],\"value\":\"application/json; charset=UTF-8\"},{\"name\":\"Date\",\"buffer\":{\"full\":false,\"empty\":false},\"valuePos\":5,\"elements\":[{\"name\":\"Mon\",\"value\":null,\"parameters\":[],\"parameterCount\":0},{\"name\":\"23 May 2016 21:46:37 GMT\",\"value\":null,\"parameters\":[],\"parameterCount\":0}],\"value\":\"Mon, 23 May 2016 21:46:37 GMT\"},{\"name\":\"Server\",\"buffer\":{\"full\":false,\"empty\":false},\"valuePos\":7,\"elements\":[{\"name\":\"Apigee Router\",\"value\":null,\"parameters\":[],\"parameterCount\":0}],\"value\":\"Apigee Router\"},{\"name\":\"User-Agent\",\"buffer\":{\"full\":false,\"empty\":false},\"valuePos\":11,\"elements\":[{\"name\":\"Apache-HttpClient/4.3.5 (java 1.5)\",\"value\":null,\"parameters\":[],\"parameterCount\":0}],\"value\":\"Apache-HttpClient/4.3.5 (java 1.5)\"},{\"name\":\"X-Forwarded-For\",\"buffer\":{\"full\":false,\"empty\":false},\"valuePos\":16,\"elements\":[{\"name\":\"54.200.58.80\",\"value\":null,\"parameters\":[],\"parameterCount\":0}],\"value\":\"54.200.58.80\"},{\"name\":\"X-Forwarded-Port\",\"buffer\":{\"full\":false,\"empty\":false},\"valuePos\":17,\"elements\":[{\"name\":\"80\",\"value\":null,\"parameters\":[],\"parameterCount\":0}],\"value\":\"80\"},{\"name\":\"X-Forwarded-Proto\",\"buffer\":{\"full\":false,\"empty\":false},\"valuePos\":18,\"elements\":[{\"name\":\"http\",\"value\":null,\"parameters\":[],\"parameterCount\":0}],\"value\":\"http\"},{\"name\":\"Content-Length\",\"buffer\":{\"full\":false,\"empty\":false},\"valuePos\":15,\"elements\":[{\"name\":\"1173\",\"value\":null,\"parameters\":[],\"parameterCount\":0}],\"value\":\"1173\"},{\"name\":\"Connection\",\"buffer\":{\"full\":false,\"empty\":false},\"valuePos\":11,\"elements\":[{\"name\":\"keep-alive\",\"value\":null,\"parameters\":[],\"parameterCount\":0}],\"value\":\"keep-alive\"}]\",\"StatusCode\":\"200\",\"Content : \":\"{\"orgName\":\"myorg\",\"developerEmail\":\"joe@example.com\",\"developerFirstName\":\"Joe\",\"developerLastName\":\"Smith\",\"applicationName\":\"MyApp\",\"packageName\":\"mypackage\",\"ratePlanName\":\"anrp\",\"ratePlanType\":\"STANDARD\",\"developerRatePlanQuotaTarget\":54000,\"quotaPercentUsed\":\"1\",\"ratePlanStartDate\":1460419200000,\"ratePlanEndDate\":null,\"nextBillingCycleStartDate\":null,\"products\":[\"product1\"],\"developerCustomAttributes\":[],
  "source": "MailTo: [c9e42fcd-9632-4376-b92d-0fa27f178a3b], Org: [myorg], TransactionId: [0352e568-2724-42d9-a264-1b62586d5948], LimitId: [RatePlan-Limit:amyorg@@@mypackage-a0y9_anrp], Key: [myorg@@@PPXsQbkyO1bBhQOh~myorg@@@mypackage-a0y9_anrp~Transactions~Calls~1]",
  "status": "NOTIFICATION_SENT",
  "toEmail": "http://123.45.67.89:8000/webhook",
  "updatedDate": 1461062402871
}