新旧API移行ガイド

はじめに

従来APIについては、2025年末〜2026年頭までに閉塞させる予定がございます。
従来APIから次世代APIへの移行のため、本ガイドをご活用ください。

・対象者: 従来APIを利用しているベンダー様、ショップ様
・判別方法: 管理画面）ショップ構築 / 設定の「注文」「商品」「会員」の各機能が利用できるかどうか。

リクエストボディ (JSON)	従来API	次世代API
API規格	REST	GraphQL
APIの形式	・操作ごとに異なるURLが用意されており、リクエスト形式が固定化されている・例えば、注文データの取得、商品データの更新などの機能がそれぞれのエンドポイントで分かれている	・単一エンドポイントを通じて、必要なデータだけをリクエストすることができる・データの構造をクエリ内で指定できるため、過剰なデータ取得や不足を防ぐことができる
柔軟性と効率性	・データ量が多い場合や、関連するリソースを取得する場合には、リクエスト回数が増える傾向	・ネストされたデータ構造（例: 注文とその関連商品情報）も一度に取得できるため、パフォーマンス向上を期待できる
エラーとデバッグ	・エラーコードが返却され、対応するエラー内容はドキュメントで確認する必要がある	・エラー情報がレスポンス内に詳細に含まれるため、デバッグが効率的に行える
認証方式	・固定的なキーを使用した認証	・トークンベースの認証（OAuth2.0）が採用されており、よりセキュアでスケーラブルな運用が可能

makeshopで運営中のショップ様が自社で開発し、自社でAPIを利用されるケース

STEP4コードの変更: ・API接続資料を基に、エンドポイントの変更
・API接続資料を基に、リクエストヘッダの変更
・field対応表を基に、field変更
・エラー処理の変更

makeshopで運営中のショップ様が自社で開発し、自社でAPIを利用されるケース

STEP3API接続資料（テスト環境）を基に、疎通確認: ・アプリ開発申請の手続き完了メールに添付されているAPI接続資料（テスト環境）をご確認ください。
・必要に応じて、各種webhookの疎通確認

STEP4コードの変更: ・API接続資料（テスト環境）を基に、エンドポイントの変更
・API接続資料（テスト環境）を基に、リクエストヘッダの変更
・field対応表を基に、field変更
・エラー処理の変更

STEP7API接続資料（本番環境）を基に、疎通確認: ・アプリ公開申請の手続き完了メールに添付されているAPI接続資料（本番環境）をご確認ください。
・各種webhookの疎通確認

STEP8コードの変更: ・API接続資料（本番環境）を基に、エンドポイントの変更
・API接続資料（本番環境）を基に、リクエストヘッダの変更
・field対応表を基に、field変更
・エラー処理の変更