PSLinkEvent仕様
PSLinkEventは、発生したイベントの種類やそのイベントに関する情報を、規定のスキーマでペイロード部分に含んでいるJWT形式として表現されます。 全イベントで共通して含まれるデータと、イベント別に含まれるデータが存在します。
共通
JWT Header
キー | 値 |
---|---|
alg | (署名付き値のJWTと同じ) |
typ | pslinkevent+jwt 固定値 |
kid | (署名付き値のJWTと同じ) |
JWT payload
キー | 値 |
---|---|
iss | PSLinkEventの発行元 ・モック環境: https://api.core.mock.p8n.app ・本番環境: https://api.core.p8n.app |
ver | 1.0 固定値 |
iat | JWT生成日時(unixtime) |
aud | PSLinkEvent通知先のサービスのID(UUID) |
jti | PSLinkEventの一意ID |
toe | PSLinkEventの発生日時(unixtime) |
events | PSLinkEventのイベント別データのオブジェクト イベント別データでイベント毎に規定されるイベントキーをどれか1つのみ含みます。 |
サンプル
Header
{
"alg": "ES256",
"typ": "pslinkevent+jwt",
"kid": "kOYoCNsODUMAvobFdTBySIUNJkUVSCb5YCSsZEqw7Mk"
}
Payload
{
"iss": "https://api.core.p8n.app",
"ver": "1.0",
"iat": 1752204930,
"aud": "6e205c39-a73b-4a5d-b2cf-1d4f0e8b0a60",
"jti": "0e30e0e1-8a6e-4d7c-8257-7b1f8df6d6c1",
"toe": 1752204925,
"events": {
"https://api.core.p8n.app/events/v1/service/subscribed": {
"subscription_id": "f9a4d8db-98e0-41b3-af12-5cb499f6e4c1"
}
}
}
イベント別データ
service/subscribed
: サービスがサブスクライブされた
イベントキー: https://api.core.p8n.app/events/v1/service/subscribed
キー | 値 |
---|---|
subscription_id | サービスをサブスクライブしたユーザーのサブスクリプションID |
サンプル:
{
"https://api.core.p8n.app/events/v1/service/subscribed": {
"subscription_id": "f9a4d8db-98e0-41b3-af12-5cb499f6e4c1"
}
}
service/unsubscribed
: サービスのサブスクライブが解除された
イベントキー: https://api.core.p8n.app/events/v1/service/unsubscribed
キー | 値 |
---|---|
subscription_id | サービスのサブスクライブを解除したユーザーのサブスクリプションID |
サンプル:
{
"https://api.core.p8n.app/events/v1/service/unsubscribed": {
"subscription_id": "f9a4d8db-98e0-41b3-af12-5cb499f6e4c1"
}
}