事件通知-钥匙订阅已更改

POST

/keyApi/v1/eventNotification

这是由设备 OEM 服务器和车辆 OEM 服务器提供的通用 API，用于在数字钥匙上传达不同的事件。
SUBSCRIPTION_CHANGED-当车辆 OEM 服务器中的数字钥匙服务订阅更改时，此通知将从车辆 OEM 服务器发送到所有者或朋友的设备 OEM 服务器。这可能发生在例如更新数字钥匙服务时。

请求参数

Header 参数

x-requestId

string

可选

设备 OEM 服务器和车辆 OEM 服务器的所有请求都应具有 HTTP 标头“x-requestId”。该值应为包含连字符的长度为 36 的 UUID。

x-device-oemId

string

可选

设备 OEM 端点的 FQDN。车辆 OEM 使用此信息启动与设备 OEM 的通信以获取特定的 keyID。 “x-device-oem-host”应由设备 OEM 服务器发送

Body 参数application/json

keyID

string

钥匙ID

必需

eventType

string

通知事件

必需

eventData

object

事件数据

必需

sharedKeys

string

所有者分享的钥匙数量

必需

shareableKeys

string

可供分享的钥匙数量

必需

keyValidTo

string

钥匙有效期结束日期。

必需

时间应以 UTC ISO-8601 格式 yyyy-MM-dd’T’HH:mm:ss.SSSZ 指定。

keyValidFrom

string

钥匙有效期开始日期。

必需

时间应以 UTC ISO-8601 格式 yyyy-MM-dd’T’HH:mm:ss.SSSZ 指定。

reason

string

触发事件的原因。

必需

仅供参考；不显示在用户界面。

示例

{
    "keyID": "483729239475C864E4F",
    "eventType": "SUBSCRIPTION_CHANGED",
    "eventData": {
        "sharedKeys": "3",
        "shareableKeys": "7",
        "keyValidTo": "2021-02-19T23:05:17.462Z",
        "keyValidFrom": "2019-02-19T23:05:17.462Z",
        "reason": "key subscription is changed"
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/keyApi/v1/eventNotification' \
--header 'Content-Type: application/json' \
--data-raw '{
    "keyID": "483729239475C864E4F",
    "eventType": "SUBSCRIPTION_CHANGED",
    "eventData": {
        "sharedKeys": "3",
        "shareableKeys": "7",
        "keyValidTo": "2021-02-19T23:05:17.462Z",
        "keyValidFrom": "2019-02-19T23:05:17.462Z",
        "reason": "key subscription is changed"
    }
}'

返回响应

🟢201成功

application/json

Body

responseHeader

object

公共响应标头

必需

statusCode

string

状态码

必需

示例

{
    "responseHeader": {
        "statusCode": "200"
    }
}

事件通知-分享钥匙已激活

事件通知-分享钥匙需要密码