よくある質問

本サイトやAPIの利用、アプリ開発に関して寄せられる、よくある質問を掲載いたします。

次世代APIを利用（アプリの公開）するまでの流れを教えてください。

まず、API 開発のためのテスト環境ご提供には、「apps developer登録」→「アプリ開発申請」が必要となります。
本番環境での API 利用は「アプリ公開申請」ご対応後に利用可能となります。

従来のAPIとの違いはなんですか？

情報取得の次世代APIについては、インタフェース利用者が必要な情報を任意に取得可能なGraphQLを採用しております。
また、従来のAPIでは取得できなかった項目も、網羅的に取得できるようになります。

従来のAPIが閉塞される可能性はありますか

従来のAPIについては、2025年末～2026年頭までに閉塞させる予定がございます。

従来のAPIと次世代APIの併用は可能ですか

恐れ入りますが、併用は当社としては推奨しておりません。

管理画面内で開発元が自由に記述できるスペースはありますか

はい、ございます。
makeshop管理画面内の「アプリ一覧」にて表示していただけます。
詳細は、開発ガイドのアプリ公開申請をご確認ください。

アプリの料金形態はどのようなものがありますか

「無料アプリ」と「有料アプリ」それぞれがあります。
プラットフォームによる課金機能については、開発ガイドの提供可能なアプリパターンをご確認ください。

アプリの掲載にmakeshop側で審査はありますか

はい、ございます。
詳細は、開発ガイドの審査をご確認ください。

アプリの公開範囲を絞ることはできますか

はい、可能です。
特定のショップ様に限定してアプリを公開することができます。

自社のショップデータを基幹システムに流し込むための社内利用としてAPIを使いたいのですが、利用は可能でしょうか。
アプリを他のショップに公開せず自社内だけで利用する予定です。

はい、ご利用可能です。
アプリを自社ショップのみ公開とすることができます。

入庫・出庫等の連携を行う予定で、御社APIへ頻繁にリクエストが飛ぶ可能性があるのですが、そもそもそういったアプリはNGでしょうか。

恐れ入りますが、レート制限を超えて大量のリクエストの送信については禁止しております。
レート制限、アクセス制限につきましては開発ガイドの制限範囲をご参照ください。

テスト環境とリリース後の本番環境で異なるWebhookURLを指定することは可能でしょうか。

はい、可能です。

テスト環境にて、インストールなどのWebhookURLは複数設定できるのでしょうか。

恐れ入りますが、WebhookURLは1種類につき1つの設定となります。
ただし、付け替えは可能ですので、ご変更が必要なタイミングでアプリ情報変更申請（テスト環境）よりご依頼いただければと存じます。
※アプリ情報変更申請（テスト環境）フォームは、アプリ開発申請の手続き完了メールに記載しております。

アプリの手数料は何％でしょうか。

makeshop（およびfincode）を介して決済される場合、料率は10％（決済手数料込み）となります。

なお、makeshopを介さずアプリ側での決済をしていただくことも可能です。
もし、アプリ側での決済をされる場合、キックバック料率等協議が必要となりますので、お問い合わせくださいませ。

アプリストアのようなものはありますか

はい、makeshop appsがございます。
makeshop appsは、makeshopをより便利にご活用いただくための様々なアプリやサービスを揃えたサイトです。
御社が開発されたアプリが公開されるタイミングでmakeshop appsにも掲載されます。
※自社ショップのみ公開や特定ショップ様に限定してアプリ公開される場合は、makeshop appsには公開されません。

アプリ（機能）設置後、ユーザー向けサポート業務はどこが実施しますか？

アプリ（機能）のユーザー向けサポート業務は開発元にて提供・実施いただきます。
予めマニュアルのご用意をいただき、アプリ公開申請の際にアプリ基本情報に記載する等ご検討ください。

今後どのようなAPIが追加されますか？スケジュールが決まっていれば教えてください。

今後は、既存APIではできなかった更新API等についての整備を進めております。
進捗状況は、開発中のAPIをご確認ください。

今後提供されるAPIのバージョンはどの程度で変更していく予定ですか？

特に明確な基準はありませんが、メジャーアップデートに関しましては、事前の告知を含めて対応させていただきます。
その他、セキュリティへの対応・使い勝手などの向上について随時変更していく予定です。

APIのバージョン更新はどのように通知されますか

本サイトのお知らせにてご案内いたします。

APIリクエスト時に401 Unauthorized が頻発するようになりました。
1日に1回各shopの商品データ更新チェックをおこなっていますが、一定数の成功後、401 Unauthorized が発生しています。

x-timestampの有効期限が切れている可能性がございます。
アプリのインストール数が増えて実行時間が増えた結果だと思われますので、1回のAPIコール前に再度x-timestamp生成をいただく等ご検討ください。
なお、x-timestampの有効期限は1時間となります。

アプリを一般公開せず、自社のみ公開する場合のアプリ作成の流れを教えてください。

アプリを自社のみ公開、限定公開する場合についても、一般公開アプリの流れと同様になります。
詳細は、開発全体の流れをご確認ください。

なお、アプリ開発・公開申請のフォーム内で「<4> アプリの公開範囲について」という項目がありますので、公開範囲をご選択いただければと存じます。

また、APIリクエスト時に必要なtokenについては、アプリインストール時に発行しwebhookで通知されますため、
自社のみ公開、限定公開する場合であっても、インストールwebhookとアンインストールwebhookで通知を受け取れるようにしていただく必要がございます。
詳細は、APIリクエストをご確認ください。

アプリ開発申請を行いましたが、その後どのように開発を進めれば良いでしょうか。

テスト環境でAPIリクエストやwebhook通知の確認を行い、開発を進めてください。
アプリ開発申請の手続き完了メールにて、テスト環境用のAPI接続情報をお送りしていますので、
テスト環境のテストショップにてダミーの商品情報などをご登録いただき、APIで取得いただく等のテストをしていただきながら開発を進めていただければと存じます。

詳細は、APIリクエストをご確認ください。

開発が完了しましたらアプリ公開申請フォーム（手続き完了メール内に記載）よりご申請ください。
審査後、本番環境のAPI接続情報をお送りしますので、最終確認後にリリースという流れとなります。

なお、APIリクエストに必要なtokenはwebhookで通知されますため、アプリを限定公開する場合であっても、インストールwebhookとアンインストールwebhookで通知を受け取れる必要がございますので、あらかじめご了承ください。