Skip to content

テナント API

ベース URL: https://{tenantCode}.{domain}/api/tenant/
認証: Authorization: Bearer <token> + authorize:tenant ミドルウェア

テナント API はサブドメインベースで分離されています。IdentifyTenant ミドルウェアがサブドメインからテナントを自動識別します。


認証

トークンでログイン

POST https://{tenantCode}.{domain}/api/auth/login-by-token

テナント専用のログイントークンを使用してサインインします。

現在のユーザー情報取得

GET https://{tenantCode}.{domain}/api/auth/me

ログイン中のテナントユーザー情報を返します。


お知らせ

メソッドパス説明
GET/api/tenant/announcements/paginatedページネーション一覧
GET/api/tenant/announcements一覧取得
GET/api/tenant/announcements/{id}詳細取得

サブスクリプション

メソッドパス説明
GET/api/tenant/subscriptions一覧取得
POST/api/tenant/subscriptions新規作成(プラン変更)
PUT/api/tenant/subscriptions/{id}/update-renew-subscription-enabled自動更新設定の変更

プラン

メソッドパス説明
GET/api/tenant/plans利用可能なプラン一覧
GET/api/tenant/plans/{id}プラン詳細
POST/api/tenant/plansプラン申込み

利用量

メソッドパス説明
GET/api/tenant/monthly-usages/get-this-month-usages今月の利用量

テナントユーザー

メソッドパス説明
GET/api/tenant/tenant-users/paginatedページネーション一覧
PUT/api/tenant/tenant-users/{id}更新
DELETE/api/tenant/tenant-users/{id}削除

テナントユーザー招待

メソッドパス説明
GET/api/tenant/tenant-user-invitations招待一覧
POST/api/tenant/tenant-user-invitations招待作成
DELETE/api/tenant/tenant-user-invitations/{id}削除
POST/api/tenant/tenant-user-invitations/{id}/revoke招待取消

テナントロール

メソッドパス説明
GET/api/tenant/tenant-roles/paginatedページネーション一覧
GET/api/tenant/tenant-roles一覧取得

ガイド

メソッドパス説明
GET/api/tenant/guides/{slug}ガイド記事取得
GET/api/tenant/guides/files/{filepath}ガイドファイル取得

Senter 連携

メソッドパス説明
GET/api/tenant/senter/serviceサービス情報
GET/api/tenant/senter/customer顧客情報
GET/api/tenant/senter/contract契約情報
POST/api/tenant/senter/contract契約更新
GET/api/tenant/senter/service-plansサービスプラン一覧
GET/api/tenant/senter/service-optionsサービスオプション一覧
GET/api/tenant/senter/service-addonsサービスアドオン一覧
POST/api/tenant/senter/service-addons/orderアドオン注文
GET/api/tenant/senter/unbilled-utilizations未請求利用量
GET/api/tenant/senter/invoices請求書一覧
GET/api/tenant/senter/invoices/{invoiceId}請求書詳細
GET/api/tenant/senter/stripe/public-keyStripe 公開鍵
POST/api/tenant/senter/stripe/customersStripe 顧客作成
POST/api/tenant/senter/stripe/setup-intentsSetupIntent 作成
PUT/api/tenant/senter/stripe/payment-methods支払方法更新
GET/api/tenant/senter/stripe/payment-methods支払方法一覧
POST/api/tenant/senter/stripe/payment-methods/set-defaultデフォルト支払方法設定
DELETE/api/tenant/senter/stripe/payment-methods支払方法削除