チェックインを保存する
チェックインの記録を作成します。API は会員、施設、タイムスタンプに基づいて重複を自動的に除外します。
パラメーター
-
check_ins
array必須保存するチェックインオブジェクトの配列。最適なパフォーマンスのため、推奨される上限はリクエストあたり 1000 項目です。API は処理のために項目を自動的にバッチ化します。各項目には、
facility_id(linking_identifierを使用しない場合は必須)またはlinking_identifier(facility_idを使用しない場合は必須)のいずれかを含める必要があります。
戻り値
同期操作を確認する簡単なメッセージを返します。
リクエスト
curl -X POST https://partner-api.performancehub.co/partner/v1/check-ins \
-u sk_live_YOUR_PARTNER_SECRET_KEY: \
-H "Content-Type: application/json" \
-d '{
"check_ins": [
{
// "check_in_id": "checkin_abc123", // Optional - auto-generated from member_id + timestamp if not provided
"member_id": "mem_12345",
"facility_id": "550e8400-e29b-41d4-a716-446655440000",
// "linking_identifier": "branch_downtown", // If using linking identifier
"check_in_type": "member",
"source": "rfid",
"timestamp": "2025-01-20T08:45:30Z"
}
]
}'
レスポンス
同期操作に関するメタデータを含む成功メッセージを返します。
{
"message": "Check-in sync successful.",
"metadata": {
"success": 523,
"skipped": 3,
"skipped_items": [
{
"member_id": "member_789",
"facility_id": null,
"reason": "No matching facility_id for the linking_identifier"
}
]
}
}
メタデータフィールド:
- success - 正常に処理されたチェックインの数
- skipped - スキップされたチェックインの数(ある場合)
- skipped_items - スキップされたチェックインとその理由の配列(ある場合)
- dry-run - dryrun キーの種類を使用している場合のブール値フラグ(該当する場合)