本文へ移動
Bounty Developer

POST/api/companies/{id}/network

「企業のつながり」の分類の、新しく作る、または操作を実行するために内容を送る API。ログインした本人として呼ぶ。

要約

企業管理者が企業QRを発行・失効する。capはdigest保存、rotate時のみURLを返す

呼び方と印

ログイン・レート制限

短い時間に呼びすぎると断られる API（レート制限）。断られたら Retry-After の秒数を待って呼び直す。

URL に付ける値（パラメータ）

経路の中の波かっこの部分と、URL の ? の後ろに付ける値。「必須」の印があるものは省けない。

  • idpath必須string(uuid)

送るもの（本文）application/json

送る本文の欄。「必須」の印がある欄は省けない。

  • action必須"rotate_qr" | "revoke_qr"

返るもの（応答）200 · application/json

成功したときに返る形。入れ子の欄は、その行を押すと開く・閉じる。「任意」の印がある欄は返らないことがある。

  • generationinteger
  • expiresAtstring | null
  • path任意string/^\/companies\/connect\/[a-f0-9]{64}$/

失敗したとき（エラー）

失敗したときの状態コードと、その意味。本文の error の値で、プログラムが失敗の種類を見分けられる。

  • 400HTTP 400（x-bounty-error-codes を参照）
  • 401HTTP 401（x-bounty-error-codes を参照）
  • 403HTTP 403（x-bounty-error-codes を参照）
  • 404HTTP 404（x-bounty-error-codes を参照）
  • 409HTTP 409（x-bounty-error-codes を参照）
  • 413HTTP 413（x-bounty-error-codes を参照）
  • 415HTTP 415（x-bounty-error-codes を参照）
  • 428HTTP 428（x-bounty-error-codes を参照）
  • 429HTTP 429（x-bounty-error-codes を参照）
  • company_network_forbidden
  • company_not_found
  • company_identity_required
  • company_qr_unavailable
  • company_qr_changed
  • recipients_changed
  • consent_required
  • company_inquiry_changed
  • company_inquiry_unavailable
  • company_network_scope_limit
  • company_sharing_scope_limit
  • company_sharing_changed
  • company_inquiry_reply_limit
  • company_inquiry_rate_limit
  • own_company_qr
  • company_event_changed
  • actor_changed
  • invalid_origin
  • unsupported_media_type

呼び出しの見本

そのまま試せる呼び出しの例。curl と fetch をタブで切り替える。ID やトークンは自分の値に置き換える。

curl -X POST "https://bounty.spikes.4s.link/api/companies/{id}/network" \
  -H "Authorization: Bearer $BEARER_AUTH" \
  -H "Content-Type: application/json" \
  -d '{
    "action": "rotate_qr"
  }'
POST /api/companies/{id}/network | Bounty Developer