公開 Shared Events REST API
このクライアントドメイン上の公開・匿名コラボレーションエンドポイント
Onepay Split と Onepay Schedule のイベントにはこれらのエンドポイントを使用します。認証済みのマーチャント・管理者 API とは別のものです。
安全な利用方法
例では明らかに架空の event ID を使用しています。アプリケーションではご自身の event link を使用し、非公開の event 値をドキュメント、チケット、ログへコピーしないでください。
curl /api/v1/split-events/evt_example_only所有権と復旧
イベントを作成したブラウザは非公開のセッションを通じて所有権を受け取ります。そのセッションを失った場合、復旧できるのはイベントの所有者だけです。
すべての event link と復旧用の値は非公開として扱ってください。共同作業に必要な event link だけを共有し、復旧情報はメッセージやログに残さないでください。
リビジョンと競合
変更前に最新のイベントを読み込み、現在のリビジョンを送信してください。別の変更が先に反映された場合は、イベントを更新して最新状態を確認してから慎重に再試行してください。
レート制限
作成、読み取り、共同変更、所有者操作、エクスポート、復旧試行にはレート制限があります。レスポンスの制限ヘッダーを守り、指定された待機時間の後にだけ再試行してください。
有効期限
Shared event は自動的に期限切れになります。イベントの読み取りやエクスポートでは有効期間は延長されないため、必要な情報は期限前にコピーしてください。
API リファレンス
Shared Events
Anonymous, cookie-scoped collaborative resources shared via a public link. Ownership is recoverable via a one-time recovery key when the owning session/cookie is lost.
POST /shared-events/{eventId}/owner/recover— Re-establish ownership of a shared event using its owner-recovery keyPUT /shared-events/{eventId}/owner/recovery-key— Rotate a shared event's owner-recovery key
Split
Split a shared expense across named members — equal-share allocation, running balances, and a simplified settlement plan. Event metadata/member management is owner-only; expense entry is collaborative.
POST /split-events— Create a Split eventGET /split-events/{eventId}— Read a Split eventPUT /split-events/{eventId}— Rename a Split event or change its currencyDELETE /split-events/{eventId}— Permanently delete a Split eventPOST /split-events/{eventId}/members— Add a Split memberPUT /split-events/{eventId}/members/{memberId}— Rename a Split memberDELETE /split-events/{eventId}/members/{memberId}— Remove a Split memberPUT /split-events/{eventId}/members/order— Reorder a Split event's active membersPOST /split-events/{eventId}/expenses— Record a Split expensePUT /split-events/{eventId}/expenses/{expenseId}— Update a Split expenseDELETE /split-events/{eventId}/expenses/{expenseId}— Delete a Split expenseGET /split-events/{eventId}/export— Export a Split event as CSV
Schedule
Schedule a meeting/event across candidate time slots — participants vote yes/maybe/no per candidate, and the owner may set a response deadline and select a final candidate. Event metadata/candidate/participant-order management is owner-only; response entry is collaborative.
POST /schedule-events— Create a Schedule eventGET /schedule-events/{eventId}— Read a Schedule eventPUT /schedule-events/{eventId}— Rename a Schedule event or change its memo, timezone, or attendance settingsDELETE /schedule-events/{eventId}— Permanently delete a Schedule eventPOST /schedule-events/{eventId}/candidates— Add a Schedule candidateDELETE /schedule-events/{eventId}/candidates/{candidateId}— Remove a Schedule candidatePUT /schedule-events/{eventId}/candidates/order— Reorder a Schedule event's candidatesPOST /schedule-events/{eventId}/responses— Create a Schedule participant responsePUT /schedule-events/{eventId}/responses/{participantId}— Update a Schedule participant responseDELETE /schedule-events/{eventId}/responses/{participantId}— Delete a Schedule participant responsePUT /schedule-events/{eventId}/participants/order— Reorder a Schedule event's participant responsesPUT /schedule-events/{eventId}/deadline— Set, change, or clear a Schedule event's response deadlinePUT /schedule-events/{eventId}/final-candidate— Select or clear a Schedule event's final candidateGET /schedule-events/{eventId}/export— Export a Schedule event as CSV