利用者通知のPOSTでマニュアル外のフィールドが付与されている・マニュアル内のHeaderが削除されている
カテゴリ: API共通
マニュアルには
リクエスト
Header
フィールド名 値/説明
Content-Type application/json
Smaregi-Contract-Id イベントの発生した契約ID
Smaregi-Event AppSubscription
Webhookで設定したカスタムヘッダーは送信されません。
Body
フィールド名 タイプ 値/説明
action string start : アプリ利用開始時
end : アプリ利用停止時
change-plan : プラン変更時
date string アクション発生日(yyyy-mm-dd)
contractId string イベントの発生した契約ID(HeaderのSmaregi-Contract-Idと同じ値)
clientId string 認証認可情報のクライアントID
plan object {"trial_days": "お試し日数(integer)", "price": "プラン価格(integer)", "name": "プラン名"}
とありますが、HeaderにはSmaregi-Eventが存在せず、Bodyはplanにquantity,unit_priceとマニュアル外のフィールドが存在します。
弊社システムではマニュアル記載通りにValidationしており、2021/12/18以降の新規契約での通知がすべてが失敗しております。
早急にマニュアル通りの通知に修正ください。
最後に弊社システムで記録されたものを示します(抜粋/改変済み)
HEADER
"Smaregi-Event-Id: xxxxx"
"Smaregi-Contract-Id: xxxx"
"Content-Type: application/json"
BODY
{
"contractId":"xxxx",
"clientId":"xxxxx",
"plan":{
"quantity":1,
"price":500,
"trial_days":0,
"name":"プラン5",
"unit_price":"500"
},
"action":"start",
"date":"2021-12-18"
},
コメント
@tohrukobayashi
まずはじめに、ご不便おかけしまして大変申し訳ございません。
Bodyはplanにquantity,unit_priceとマニュアル外のフィールドが存在します。
こちらについては、ドキュメント修正漏れということで、既知のバグとして01/17に反映予定でした。
次に
HeaderにはSmaregi-Eventが存在せず
こちらについては現在、動作 / 経緯ともに調査中でございます。
恐れ入りますが、今しばらくお待ちくださいませ。
@tohrukobayashi
こちら続報となります。
デベロッパーの皆様に対しメール通知を行い、スマレジ・デベロッパーズのお知らせに掲載させていただきました。
この内容をこちらにも転記させていただき、回答といたします。
---
障害内容
利用者通知のWebhookの送信内容において、リクエストヘッダー
Smaregi-Event: AppSubscriptionを含まない状態で送信している。発生経緯
12月17日(金)にWebhook送信数増加に対応するシステムアップデートを実施。
アップデートでの処理変更により、利用者通知の
Smaregi-Eventリクエストヘッダーが欠落した。解決に向けての対応
2021年12月27日(月) 13:00に修正アップデートを実施予定。
障害期間中に発生した利用者通知の再送を、修正アップデート前の2021年12月27日(月) 12:00~13:00 に実施予定。
この再送はPFアプリ側の利用者通知の処理に影響があることが考えられるため、希望されるPFアプリにのみ実施します。
(つきましては、再送を希望される場合は 2021年12月27日(月) 12:00 までにご連絡ください。)
(その後の再送に関しましては都度相談とさせてください)
その他
サービス(POS, Waiter)のWebhook送信に影響は発生しておりません。
---
@tohrukobayashi
こちら、@tohrukobayashi 様のシステムで利用者通知の再送を必要な場合、月曜日12時〜13時にかけて再送を行う準備となっております。
もし必要な場合、developers@smaregi.jp へ問い合わせいただくか、私にDMなどでご連絡いただければ対応させていただきます。
この度はご迷惑おかけし申し訳ございませんでした。
なにか他にご不明点がございましたら、スレッドを伸ばしてコメントしていただければと思います。