企業ページ
企業ページの API。会社を非公開で登録し、紹介・ロゴ・メンバーを管理する。会社のページとメンバーは下書きとして保存し、限定リンクで本人に受け取ってもらう。
この分類のあらまし
- 誰が呼べるか
会社の管理者が、ログインか会社の scope のトークンで呼ぶ。限定リンクを確定する入口は、リンクを受け取った本人が呼ぶ。
ログイン 20 件・認証なし 1 件
- 件数と印
この分類の API は 21 件・レート制限 12 件
短い時間に呼びすぎると断られる API(レート制限)。断られたら Retry-After の秒数を待って呼び直す。
- 契約での分類の説明
企業ページ・メンバーの下書きと限定リンク(会社 scope の API トークン / ログイン。公開はしない)
よく使う順番
上から順に呼ぶことが多い組み合わせ。行を押すと、その API の詳細が右に開く(スマホは下から)。
すべての API21 件
この分類の API をすべて並べている。行を押すと、頁を移らずにその API の詳細が右に開き、送るもの・返るもの・呼び出しの見本が読める。閉じると一覧の同じ位置に戻る。
行の左の札は HTTP のメソッド。GET は情報の取得、POST は作成や操作の実行、PUT と PATCH は更新、DELETE は削除を表す。
- 下書きできる会社と上限(運営 admin は全社、会社の管理者は自社。公開なし)GET取得
/api/companies/drafts/contextログイン・レート制限 - 会社ページの下書きを検証(書込みなし。ロゴの upload は消費しない)POST作成・操作
/api/companies/drafts/previewログイン・レート制限 - 会社ページを非公開の下書きとして保存(新規は運営 admin、更新は自社の管理者も可。公開中は 409)POST作成・操作
/api/companies/drafts/upsertログイン・レート制限 - 会社ページの下書き・版・公開状態・メンバー下書きの件数を読むGET取得
/api/companies/drafts/{id}ログイン・レート制限 - 自社のメンバー下書きの一覧(本文・リンクは返さない)GET取得
/api/companies/{id}/member-draftsログイン・レート制限 - メンバー下書き(50 件まで)を検証(書込みなし)POST作成・操作
/api/companies/{id}/member-drafts/previewログイン・レート制限 - メンバー下書きを sourceKey で保存(アカウントは作らない・同意を代行しない・公開なし)POST作成・操作
/api/companies/{id}/member-drafts/upsertログイン・レート制限 - 本人用の受け取りリンクを作る(応答で 1 度だけ返す。作り直すと前のリンクは無効。送信はしない)POST作成・操作
/api/companies/{id}/member-drafts/{draftId}/linkログイン・レート制限 - メンバー下書きを破棄する(提案の本文を消す・リンクは無効)POST作成・操作
/api/companies/{id}/member-drafts/{draftId}/discardログイン・レート制限 - 限定リンクを本人が確定して会社へ入る(ログイン必須・回数と期限つき)POST作成・操作
/api/companies/invite/{code}ログイン・レート制限 - メンバー下書きを本人が確定する(選んだ項目だけ自分のプロフィールへ入れ、会社へ入る。1 回限り)POST作成・操作
/api/companies/claim/{code}ログイン・レート制限 - 管理できる会社の一覧(運営 admin は全社、会社の管理者は自社)GET取得
/api/companiesログイン - 会社を非公開で登録し、最初の管理者を迎える限定リンクを作る(ブラウザのログインだけ)POST作成・操作
/api/companiesログイン(cookie) - 会社の管理画面の内容(会社・メンバー・出しているコンテンツ・審査の状態)GET取得
/api/companies/{id}ログイン - 会社の紹介・ロゴ・公開の設定を直す(会社の管理者か運営 admin)PATCH一部を更新
/api/companies/{id}ログイン - 社員が会社へ入るリンクを作り直す・止める(作り直すと前のリンクは使えない)POST作成・操作
/api/companies/{id}/join-linkログイン - 会社のメンバーを足す・役割を変える・外す(最後の管理者は外せない)POST作成・操作
/api/companies/{id}/membersログイン - 会社のメンバーに足す人を名前で探す(2 字以上・名前と写真だけ)GET取得
/api/companies/{id}/peopleログイン - 会社のロゴを上げる(WebP に書き直す。companyId か eventId で対象を指定)POST作成・操作
/api/companies/imagesログイン・レート制限 - 会社のロゴ画像(公開中の会社のもの、または上げた本人・会社の管理者のプレビュー)GET取得
/api/companies/images/{id}認証なし(任意) - 社員用のリンクを本人が確定して会社へ入るPOST作成・操作
/api/companies/join/{token}ログイン