コンテンツにスキップ

Crewcade API

Crewcade API で、自分のウェブサイトやアプリをクラブとつなげます。画面はあなたが作ります。メンバーの管理は Crewcade が担います。

Crewcade で作ったキーを使い、あなたのサーバーからクラブのメンバーとイベントを読み取ります。あなたのウェブサイトやアプリで、メンバーが Crewcade アカウントでサインインすることもできます。サインイン後、メンバーが許可した名前、写真、メールアドレスをアプリが読み取れます。アプリは、そのメンバーが見られるイベントも読めます。権限を足すと、メンバーを無料のイベントに申し込ませたり、イベントに参加する人を表示したりできます。Crewcade でサインインと連携アプリを見てください。

クラブで何かが変わったときに、サーバーでメッセージを受け取ることもできます。これが Webhook です。Webhookを見てください。

  1. Crewcade で 設定 を開き、開発者 を選びます。APIキー タブを開きます。メンバー閲覧 権限でキーを作ります。
  2. キーをコピーします。キーは cck_ で始まります。
  3. 自分のパソコンで次を実行します。
Terminal window
curl https://api.crewcade.com/api/v1/members \
-H "Authorization: Bearer cck_your_key_here"

クラブのメンバーが最初の 20 人分返ってきます。

リクエストはすべて次のベース URL に送ります。

https://api.crewcade.com/api/v1

キーを作れるのは、連携管理 権限を持つ人です。オーナーと管理者は最初から持っています。

  1. 設定 を開き、開発者 を選びます。APIキー タブを開きます。
  2. APIキーを作成 を押します。名前、権限、有効期限を決めます。
  3. キーをコピーします。キーは cck_ で始まります。

キーが表示されるのは一度だけです。安全な場所に保管してください。なくした場合は、そのキーを無効にして新しく作ります。キーが作られるたびに、クラブのオーナーにメールが届きます。

キーはサーバーだけに置きます。ウェブページや携帯アプリに入れたキーは公開されたのと同じです。見つけた人は誰でも使えてしまいます。

キーを Authorization ヘッダーに入れて送ります。

Terminal window
curl https://api.crewcade.com/api/v1/key \
-H "Authorization: Bearer cck_your_key_here"

返事には、このキーでできることが表示されます。

{
"keyId": "key_123",
"workspaceId": "k3m9x2pq4r7t",
"permissions": ["can_view_members"]
}

権限はキーを作るときに選びます。選べるのは、自分が持っている権限だけです。

権限Crewcade での名前できること
can_view_membersメンバー閲覧メンバーを読む
can_view_sensitive_member_data機微なメンバー情報の閲覧機微な項目の回答も読む。読み取りはすべて記録されます。
can_view_all_eventsすべてのイベントを表示非表示のものも含めてイベントを読む。下書きは含みません。
can_check_in_attendees参加者チェックインイベントの参加者を読む(can_view_all_events と一緒に使います)
can_manage_webhooksWebhook管理Webhook のエンドポイントを追加、変更、削除する

新しい権限は、それを使うエンドポイントと一緒に追加されます。

キーは、作った人以上のことはできません。次の場合、キーは使えなくなります。

  • 作った人が権限や 連携管理 を失った、またはクラブを退会した。
  • キーの有効期限が切れた。
  • キーが無効にされた。

有効期限は 30 日、90 日、1 年、無期限から選べます。初期設定は 1 年です。

ステータス意味
401キーが正しくありません。本文は毎回 Invalid API key です。
403キーに権限が足りません。本文に code: "api_key_permission_missing" と missingPermissions の一覧が入ります。
404求めたものがクラブに存在しません。
429リクエストが多すぎます。本文は rate_limited です。Retry-After ヘッダーの秒数だけ待ってください。

1 つのキーで送れるのは、1 分あたり 60 リクエストです。正しいキーへの返事には、次のヘッダーが付きます。

  • RateLimit-Limit は上限です。
  • RateLimit-Remaining は残りのリクエスト数です。
  • RateLimit-Reset はカウントが戻るまでの時間です。

同じ IP アドレスから 1 分間にキーの認証に 10 回失敗すると、その分が終わるまでそのアドレスはブロックされます。

メソッドとパス権限ページ
GET /keyどのキーでも可このページ
GET /memberscan_view_membersメンバー
GET /members/{memberId}can_view_membersメンバー
GET /eventscan_view_all_eventsイベント
GET /events/{id}can_view_all_eventsイベント
GET /events/{id}/registrationscan_view_all_events、can_check_in_attendeesイベント
GET /events と GET /events/{id}メンバートークン(追加のスコープは不要)イベント
GET /me/registrationsregistrations のメンバートークン申し込み
GET、POST、DELETE /events/{id}/registrationregistrations のメンバートークン申し込み
GET /events/{id}/peoplepeople のメンバートークン出会う人
GET /meメンバートークン自分とクラブ
GET /workspace任意のキーまたはメンバートークン自分とクラブ
/webhook-endpoints とそのサブパスcan_manage_webhooksWebhook

GET /me と GET /workspace は、Crewcade でサインインで得たメンバートークンでも使えます。メンバーのエンドポイントと GET /events/{id}/registrations には APIキー が必要です。イベントのエンドポイントは、どのメンバートークンでも使えます。

どの /v1 リクエストにも ?locale=ja を付けると、言語を選べます。Accept-Language ヘッダーでも選べます。両方送った場合は locale が優先されます。自分とクラブを見てください。

機械で読める仕様ファイルはここにあります。

https://docs.crewcade.com/openapi/v1.json

OpenAPI 3.0 形式で、API のコードから作られています。上のエンドポイント、項目、エラーがすべて入っています。次のように使えます。

  • Postman、Insomnia、Bruno で各リクエストを試す。
  • OpenAPI Generator などのツールで、自分の言語の型付きクライアントを作る。
  • AI コーディングツールに、返事の正確な形を渡す。