来店記録
来店記録API
エンドポイント
URL | https://poster.ooo/api/v1/user/{user_id}/visit/set |
---|---|
Method | POST |
Header
X-POSTER-CLIENT-ID | Posterから発行された40文字の文字列 (Poster管理画面から確認して下さい。) |
---|---|
X-POSTER-CLIENT-SECRET | Posterから発行された80文字の文字列 (Poster管理画面から確認して下さい。) |
Request
送信方法 | 型 | 説明 |
---|---|---|
URLの{user_id}部分にセット | 数字 または 文字列 | PosterユーザーID または Poster会員番号(2x-xxxxx-xxxxxx) |
RequestBodyにセットできるパラメータ(JSON文字列)
パラメータ名 | 省略 | 型 | 説明 |
---|---|---|---|
branch_id | 可 | 数字 | 作成済みの拠点ID(省略時は拠点なしの来店記録が作成されます) |
visited_at | 可 | 文字列 (YYYY-MM-DD HH:ii:ss) | 来店日時(省略時は現在時刻) |
Requestデータサンプル
{
"branch_id": 9999999999,
"visited_at": "2020-08-01 10:00:00"
}
ResponseBody (JSON)
送信方法 | 型 | 説明 |
---|---|---|
message | 文字列 | 成功時:「success」 エラー時はエラーメッセージ |