API リファレンス
名刺交換 / ミートログ
- GET
/card-exchanges/:exchangeId名刺交換の状態当事者から見た交換の状態を返します。申し込んだ側は相手の承認を待つ間これをポーリングし、status が ACCEPTED になったら result を使って次へ進みます。result.candidateEvents が 1 件以上なら会ったイベントを選ぶ画面を表示し、PATCH /meet-logs/:meetLogId で eventId を記録してください(1 件のときは result.eventId に自動で入っているので、選んだ状態で表示し、外されたら eventId: null を送ります)。 - POST
/card-exchanges名刺交換を始める(スキャン)相手のマイ QR コード(`https://4s.link/{slug}?ref=code&token=...`)の token を送り、名刺交換を始めます。相手のプロフィールの要約を返すので、「交換を申し込む」画面に表示してください。token は QR をその場で読んだ証拠なので、slug だけでは交換を始められません。交換中のデータは 1 ユーザーにつき常に最新の 1 件だけで、それまで交換中だった交換は消えます。コミュニティの名刺の QR コード(`https://4s.link/communities/{communityId}?ref=code&token=...`。token はその名刺を出している管理者のもの)を読んだときは、パスのコミュニティ ID を targetCommunityId に入れて送ります。自分が管理者のコミュニティとして申し込むときは asCommunityId を送ります。 - GET
/card-exchanges/current現在の名刺交換認証中ユーザーの交換中の名刺交換を返します。交換中でなければ exchange は null です。マイ QR コードを表示している間にポーリングし、role が TARGET で status が PENDING なら、相手の申し込みを確認する画面を開いてください。 - PUT
/card-exchanges/:exchangeId/request名刺交換を申し込むスキャンした相手に名刺交換を申し込みます(SCANNED → PENDING)。相手の公式アプリにプッシュ通知を送り、相手が承認するまで 3 分待ちます。相手が交換中だった別の交換は消えます。 - PUT
/card-exchanges/:exchangeId/accept名刺交換を承認する申し込まれた側が交換を承認し、成立させます。当事者 2 人それぞれにミートログが記録されます。その時点で 2 人とも参加している開催中のイベントが 1 件だけなら、会ったイベントとして自動で記録します。どちらかがコミュニティとして交換したときは、その側の記録はコミュニティの記録になり、コミュニティの現在の管理者全員で共有します。 - PUT
/card-exchanges/:exchangeId/decline名刺交換を見送る申し込まれた側が交換を見送ります。交換は削除され、申し込んだ側の GET /card-exchanges/:exchangeId は 404 になります。もう無い交換を指定しても成功します。 - PUT
/card-exchanges/:exchangeId/cancel名刺交換をやめる申し込んだ側が交換をやめます。申し込みの前後どちらでも呼べます。もう無い交換を指定しても成功します。 - GET
/meet-logs/contacts交換した人の一覧名刺交換した相手を、最後に交換した順に返します。同じ相手と何度交換しても 1 人 1 件です。既定では個人どうしの交換だけを返します。includeCommunities=true でコミュニティと交換した名刺も混ぜ、asCommunityId でそのコミュニティが交換した相手の一覧(管理者のみ)に切り替えます。 - GET
/meet-logs/contacts/:userId相手との交換の記録指定した相手との交換の記録(新しい順)と、メールアドレスの開示状況を返します。交換していない相手なら contact は null、meetLogs は空です。個人どうしの交換だけが対象で、その相手が管理者として担当したコミュニティとの交換は含みません(GET /meet-logs/communities/:communityId)。asCommunityId を指定すると、そのコミュニティとその相手の記録を返します(管理者のみ)。 - PATCH
/meet-logs/contacts/:userIdメールアドレスの開示を切り替える自分のメールアドレスを指定した相手に開示するかを切り替えます。相手ごとに、いつでも変えられます。 - GET
/meet-logs/communities/:communityIdコミュニティとの名刺交換認証中ユーザーと、指定したコミュニティとの名刺交換(自分の開示設定・メルマガの購読・記録)を返します。交換していない、またはコミュニティが削除済みなら contact は null、meetLogs は空です(404 にはしません)。コミュニティの公開範囲や、メンバーかどうかに関係なく返します。名刺交換してもコミュニティへの参加にはならず、メンバーでも自動で購読にはなりません。 - PATCH
/meet-logs/communities/:communityIdコミュニティへの開示とメルマガの購読を切り替える名刺交換したコミュニティに、自分のメールアドレスを開示するか・そのコミュニティのメルマガを受け取るかを切り替えます。メルマガを受け取る(subscribeNewsletter が true)間は、shareEmail が false でもメールアドレスをコミュニティに開示します。4S はメルマガを配信しません。コミュニティの管理者が、CSV の購読フラグを見て独自に配信します。 - PATCH
/meet-logs/:meetLogId交換の記録を編集する自分の記録のメモ・会ったイベントを変えます。メモは自分にしか見えません。会ったイベントは、交換した時点の候補(candidateEvents)の中からだけ選べます。 - DELETE
/meet-logs/:meetLogId交換の記録を削除する交換の記録を削除します。相手の記録からも消えます。同じ相手との記録がすべて消えると、交換した人の一覧からも外れ、メールアドレスも見えなくなります。 - POST
/meet-logs/exportCSV をメールで受け取る交換した人の CSV(1 人 1 行)をダウンロードできるリンクを、認証中ユーザーのメールアドレスに送ります。リンクは 24 時間有効です。自分の CSV には、コミュニティと交換した名刺も入ります(末尾の「種別」列で見分けられます)。asCommunityId を指定すると、そのコミュニティが交換した相手の CSV(「メルマガ購読」列つき)になります。