営業に問い合わせるログイン無料で始める
Developers
APIリファレンスConnect 会員

Connect 会員

事業ユニットに紐づくサービスの外部会員。会員向けに発行した専用キーを使う

エンドポイント
GET/v1/connect/members

このサービスに登録した外部会員を参照する

権限 connect:members:readnextCursor で続き

クエリ

  • limitinteger

    1〜100

  • cursorstring

    100文字まで

  • statusenum
    activeinactive

返る項目data の中身 · 200

  • idstring
  • externalIdstring
  • publicHandlestring | null
  • statusenum
    activeinactive

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限（scope）が付いていない。requiredScopes に必要な権限が入ります

GET/v1/connect/members
curl https://tooon.app/api/v1/connect/members \
  -H "Authorization: Bearer $TOOON_API_KEY"
レスポンス
{
  "data": [
    {
      "id": "clx8k2m0a0001",
      "externalId": "member-0001",
      "publicHandle": "taro",
      "status": "active"
    }
  ],
  "nextCursor": null
}
POST/v1/connect/members

外部会員を登録する

同じサービスのexternalIdに対して1件だけ作ります。既定ではnameを使って未公開の名刺も作ります。createBusinessCard=falseなら名刺を作らず会員だけを登録でき、nameは省略できます。再送で既存の名刺を書き換えたり、退会済み会員を復活させたりしません。メールアドレスを自動転記しません。任意のpublicHandleを指定すると会員作成と同時に公開IDを取得します。競合は409 public_handle_taken、取得後の変更は409 public_handle_already_claimedです。

権限 connect:members:writeIdempotency-Key

送る項目JSON · 4項目

  • externalIdstring必須

    200文字まで

  • namestring

    名刺を作る場合に必要な表示名

    80文字まで

  • createBusinessCardboolean

    falseなら名刺を作らず会員だけを登録します。既定true

  • publicHandlestring

    英小文字・数字・ハイフン。先頭と末尾は英数字。大文字は小文字に変換します

    3〜30文字

返る項目data の中身 · 200

  • idstring
  • externalIdstring
  • publicHandlestring | null
  • statusenum
    activeinactive

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限（scope）が付いていない。requiredScopes に必要な権限が入ります

  • 409public_handle_taken

    競合

  • 409public_handle_already_claimed

    取得後の変更のとき

POST/v1/connect/members
curl -X POST https://tooon.app/api/v1/connect/members \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "externalId": "member-0001",
  "name": "山田 太郎"
}'
レスポンス
{
  "data": {
    "id": "clx8k2m0a0001",
    "externalId": "member-0001",
    "publicHandle": "taro",
    "status": "active"
  }
}
POST/v1/connect/members/{externalId}/public-handle

会員の公開URL用IDを取得する

サービスごとに先着で取得します。英小文字・数字・ハイフンの3〜30文字。1会員1IDで、取得後の変更や退会後の再割り当てはできません。同じIDの再送は成功します。他の会員が取得済みなら409 public_handle_taken、取得後に別IDを指定したら409 public_handle_already_claimedを返します。IDの取得だけでは名刺は公開されません。

権限 connect:members:writeIdempotency-Key

パスの値

  • externalIdstring必須

    200文字まで

送る項目JSON · 1項目

  • publicHandlestring必須

    英小文字・数字・ハイフン。先頭と末尾は英数字。大文字は小文字に変換します

    3〜30文字

返る項目data の中身 · 200

  • idstring
  • externalIdstring
  • publicHandlestring | null
  • statusenum
    activeinactive

起こりうるエラー共通のエラー

  • 400invalid_request

    送った値が正しくない。message にどこが違うかが入ります

  • 403insufficient_scope

    キーにこの入口の権限（scope）が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

  • 409public_handle_taken

    他の会員が取得済みのとき

  • 409public_handle_already_claimed

    取得後に別IDを指定したらのとき

POST/v1/…/members/{externalId}/public-handle
curl -X POST https://tooon.app/api/v1/connect/members/member-0001/public-handle \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "publicHandle": "taro"
}'
レスポンス
{
  "data": {
    "id": "clx8k2m0a0001",
    "externalId": "member-0001",
    "publicHandle": "taro",
    "status": "active"
  }
}
POST/v1/connect/members/{externalId}/deactivate

外部会員の利用を停止する

名刺の公開と事業アカウントの利用を停止し、この会員に対する以降の編集・公開・再登録を拒否します。事業アカウントのデータは削除しません。同じ通知を再送できます。

権限 connect:members:writeIdempotency-Key

パスの値

  • externalIdstring必須

    200文字まで

返る項目data の中身 · 200

  • idstring
  • externalIdstring
  • publicHandlestring | null
  • statusenum
    activeinactive

起こりうるエラー共通のエラー

  • 403insufficient_scope

    キーにこの入口の権限（scope）が付いていない。requiredScopes に必要な権限が入ります

  • 404not_found

    対象がない、またはこのワークスペースのものではない

POST/v1/…/members/{externalId}/deactivate
curl -X POST https://tooon.app/api/v1/connect/members/member-0001/deactivate \
  -H "Authorization: Bearer $TOOON_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)"
レスポンス
{
  "data": {
    "id": "clx8k2m0a0001",
    "externalId": "member-0001",
    "publicHandle": "taro",
    "status": "active"
  }
}