よくある質問

β版について

β版の仕様は変わりますか？

β版のため、v2 の仕様は予告なく変更されることがあります。変更の内容は変更履歴で確認することができます。

正式リリースはいつですか？

2026 年末を目標に開発を進めています。追加予定の機能は今後の開発ロードマップで確認することができます。

リクエスト数に上限はありますか？

β版では上限を設けていませんが、正式リリースに向けて上限を設けます。上限値は導入の前にお知らせします。

Personal Access Token（PAT）と認証

PAT はどのような用途を想定していますか？

ショップ自身が自分のショップを管理するために使うことを想定しています。たとえば、自分のショップの商品や注文を外部のシステムと連携したり、運営業務を自動化したりする用途です。

PAT をアプリ開発者や連携サービスに渡してもよいですか？

第三者が提供するアプリやサービスとの連携には、今後提供する OAuth 2.0 を使っていただく予定です。OAuth 2.0 の提供を始めた後は、PAT を第三者に渡して使わせることは控えてください。

複数のショップ向けにアプリを提供したい場合はどうすればよいですか？

v2 の OAuth 2.0 の提供を待ってください。OAuth 2.0 は正式リリースまでに提供する予定です。それまでは、v1 の OAuth 2.0 を引き続き利用することができます。OAuth 2.0 の提供を始めた後は、ショップから PAT を受け取って使うことは控えてください。

PAT の有効期限が切れるとどうなりますか？

期限を過ぎた PAT でのリクエストには 401（/errors/auth/unauthenticated）を返します。有効期限は発行後に変更できないため、期限が切れる前に BASE Developers で新しい PAT を発行して差し替えてください。

取得したデータの扱い

API で取得したデータは何に使えますか？

API で取得した情報の利用目的は、API 利用規約の第5条の2第2項で、利用者ショップの運営及び管理に限られています。

購入者の個人情報を含まない形で注文を取得できますか？

できません。注文の取得・検索のレスポンスには、購入者の氏名・住所・電話番号・メールアドレスと、配送先の氏名・住所・電話番号が含まれ、返す項目を絞る指定はありません。個人情報が不要な場合は、必要な項目だけを保存し、個人情報は保存しないようにしてください。保存する場合は、API 利用規約に従って扱ってください。

v1 API について

v1 API から移行するには、どうすればよいですか？

v2 で未対応の機能と移行の手順は移行ガイドで確認することができます。