# BASE API（β版） BASE の商品や在庫、注文を管理するための API です。 外部システムとのデータ連携や、ショップの運営業務の自動化に利用できます。 **β版のため**、正式リリースまでに API の仕様が変更、調整される可能性があります。 ## クイックスタート BASE API の利用には、BASE のアカウントが必要です。 Personal Access Token（PAT）を使って、アカウント情報とショップ情報を取得します。 1. [BASE Developers](https://developers.thebase.com/apiv2) で、`user.read` スコープを持つ Personal Access Token を発行します。 2. 次の例の `` をトークンに置き換え、リクエストを送信します。 ```sh curl -H "Authorization: Bearer " \ https://apiv2.thebase.com/api/user ``` 成功すると `200 OK` とともに、アカウント情報とショップの名称・公開 URL などを JSON 形式で返します。 レスポンスの各項目は [認証ユーザーとショップの情報取得](/docs/endpoints/get-api-user.md)で確認することができます。 ## 基本仕様 | 項目 | 内容 | | --- | --- | | API URL | `https://apiv2.thebase.com` | | 認証 | `Authorization` ヘッダーに `Bearer ` の形式で PAT を指定します。β版では OAuth フローを提供しません。 | | スコープ | 各エンドポイントの利用には、その操作が要求するスコープが必要です。権限の考え方と一覧は[スコープ](/docs/scopes.md)で確認することができます。 | | リクエスト | パスやクエリに指定するパラメータは、各エンドポイントの定義に従います。JSON のリクエストボディを送信する場合は、`Content-Type: application/json` を指定します。 | | レスポンス | データは JSON 形式で返します。`204 No Content` の場合はレスポンスボディを返しません。成功時のステータスコードとデータの構造は、各エンドポイントに記載しています。エラー時は HTTP ステータスコードと、Problem Details 形式の JSON を返します。エラーの構造と種別は[エラーレスポンス](/docs/errors.md)で確認することができます。 | ## API リファレンス 操作するデータから、エンドポイントを探すことができます。 - [商品](/docs/reference.md#商品): 商品の取得・作成・編集と在庫の管理。 - [商品カテゴリ](/docs/reference.md#商品カテゴリ): 商品を分類するカテゴリの管理と、商品との結びつけ。 - [注文](/docs/reference.md#注文): 注文の参照・検索・更新と発送・キャンセル。 - [配送業者](/docs/reference.md#配送業者): 発送時に指定できる配送業者の一覧。 - [ファイル](/docs/reference.md#ファイル): ファイルのアップロード先の発行。商品画像などファイルを扱う操作の入口。 - [ユーザー](/docs/reference.md#ユーザー): 認証中のユーザー情報の取得。 ## v1 API からの移行 v1 API を利用している場合は、[移行ガイド](/docs/migration.md)で認証方式やエンドポイント、フィールドの変更点を確認することができます。 ## 今後の開発ロードマップ 2026 年末に予定している正式リリースに合わせて、次の機能を提供する予定です。 - OAuth 2.0 による認証 - レートリミットによる API の利用回数の制限 - 引き出し申請関連の API（`/1/savings`） v1 の商品検索 API（`GET /1/items/search`）に相当する API の提供予定はありません。 ## 関連情報 - [BASE Developers](https://developers.thebase.com/) - [API 利用規約](https://thebase.com/pages/api_term) - [ヘルプ：BASE API について](https://help.thebase.in/hc/ja/sections/8507567845017)