Apple Push Notification Service绑定规范

有关 Apple 推送通知服务绑定组件的详细文档

配置

要设置Apple Push Notifications绑定,请创建一个类型为bindings.apns的组件。 See this guide on how to create and apply a binding configuration.

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: <NAME>
  namespace: <NAMESPACE>
spec:
  type: bindings.apns
  version: v1
  metadata:
    - name: development
      value: <bool>
    - name: key-id
      value: <APPLE_KEY_ID>
    - name: team-id
      value: <APPLE_TEAM_ID>
    - name: private-key
      secretKeyRef:
        name: <SECRET>
        key: <SECRET-KEY-NAME>

元数据字段规范

字段 必填 绑定支持 详情 Example
development Y 输出 告诉绑定使用哪个APNs服务。 设置为 true 以用于开发环境, false 用于生产环境。 默认: "true" “true”
key-id Y 输出 来自 Apple 开发者门户的私钥的标识符。 "private-key-id
team-id Y 输出 来自 Apple 开发者门户的组织或作者的标识符。 "team-id"
private-key Y 输出 是一个PKCS #8格式的私钥。 其目的是将私钥存储在密钥存储中,而不是直接暴露在配置中。 请参阅这里了解更多详情。 "pem file"

私钥

APNS绑定需要一个加密私钥,以便为APNS服务生成认证令牌。 私钥可以从Apple开发者门户生成,并以PKCS #8文件的形式提供,私钥以PEM格式存储。 私钥应该存储在Dapr的密钥存储中,而不是直接存储在绑定的配置文件中。

APNS绑定的配置文件示例如下所示:

apiVersion: dapr.io/v1alpha1
kind: Component
metadata:
  name: apns
  namespace: default
spec:
  type: bindings.apns
  metadata:
  - name: development
    value: false
  - name: key-id
    value: PUT-KEY-ID-HERE
  - name: team-id
    value: PUT-APPLE-TEAM-ID-HERE
  - name: private-key
    secretKeyRef:
      name: apns-secrets
      key: private-key

如果使用Kubernetes,一个示例的密钥配置可能是这样的:

apiVersion: v1
kind: Secret
metadata:
    name: apns-secrets
    namespace: default
stringData:
    private-key: |
        -----BEGIN PRIVATE KEY-----
        KEY-DATA-GOES-HERE
        -----END PRIVATE KEY-----

绑定支持

字段名为 ttlInSeconds

  • create

输出绑定支持的操作

APNS 绑定是Apple Push Notification Service的通行证封装。 APNS绑定会直接将请求发送到APNS服务,不需要任何翻译。 因此,了解APNS服务所期望的推送通知的有效载荷非常重要。 有效载荷格式在这里有详细文档。

请求格式

{
    "data": {
        "aps": {
            "alert": {
                "title": "New Updates!",
                "body": "There are new updates for your review"
            }
        }
    },
    "metadata": {
        "device-token": "PUT-DEVICE-TOKEN-HERE",
        "apns-push-type": "alert",
        "apns-priority": "10",
        "apns-topic": "com.example.helloworld"
    },
    "operation": "create"
}

data对象包含完整的推送通知规范,如Apple文档中所述。 data对象将直接发送到APNs服务。

除了device-token值之外,Apple文档中指定的HTTP头信息可以作为元数据字段发送,并将包含在向APNs服务发出的HTTP请求中。

响应格式

{
    "messageID": "UNIQUE-ID-FOR-NOTIFICATION"
}

相关链接

Last modified January 1, 0001