本サイトやAPIの利用、アプリ開発に関して寄せられる、よくある質問を掲載いたします。
- 次世代APIを利用/アプリ公開するまでの流れを教えてください。
-
ベンダー様の場合、「利用登録」→「アプリ開発申請」→「アプリ公開申請」となります。
ショップ様の場合、「利用登録」→「API自社利用申請」となります。
詳細は、利用登録ページをご確認ください。
- 従来のAPIとの違いはなんですか?
-
情報取得の次世代APIについては、インタフェース利用者が必要な情報を任意に取得可能なGraphQLを採用しております。
また、従来のAPIでは取得できなかった項目も、網羅的に取得できるようになります。
- 従来のAPIが閉塞される可能性はありますか
-
従来のAPIについては、2025年末~2026年頭までに閉塞させる予定がございます。
- 従来のAPIと次世代APIの併用は可能ですか
-
誠に恐れ入りますが、次世代APIへの移行をお願いいたします。
- 管理画面内で開発元が自由に記述できるスペースはありますか
-
はい、ございます。
makeshop管理画面内の「アプリ一覧」にて表示していただけます。
詳細は、開発ガイドのアプリ公開申請をご確認ください。
- アプリはどのような提供形態が可能ですか
-
「無料」か「有料」での提供が可能です。
「有料」で提供する場合、主にサブスクや従量課金、買い切りなどの課金形態に対応可能です。
- 有料アプリはmakeshop経由での決済となりますか
-
以下、いずれかの方法をご選択いただけます。
・makeshop appsを介した決済(手数料率10%)
・makeshop apps外での独自決済(手数料率20%)
※独自決済をご希望の場合、お問い合わせが必要となります。
- 「makeshop appsを介した決済(手数料率10%)」と「makeshop apps外での独自決済(手数料率20%)」について教えてください
-
「makeshop appsを介した決済」は、自由決済APIを利用いただくことで、従量課金やサブスク、都度課金などにも対応できます。
決済はイプシロン社のfincodeにて取りまとめられ、手数料を除いた金額が御社へ振り込まれる仕組みです。
「makeshop apps外での独自決済」は、御社で既にお持ちの決済ロジックに乗せる形式となります。
- makeshop appsを介した決済(手数料率10%)とは別にfincodeの決済手数料がかかりますか
-
いいえ、makeshop appsを介した決済で発生する手数料は10%のみとなります。
- makeshop appsを介した決済での入金サイクルを教えてください
-
fincodeの仕様に準じており、以下のサイクルからお選びいただけます。
・月1回 (末日締め、翌月末日入金)
・月2回 (15日締め、当月末日入金/月末締め、翌月15日入金)
- アプリの掲載にmakeshop側で審査はありますか
-
はい、ございます。
詳細は、開発ガイドの審査をご確認ください。
- アプリの公開範囲を絞ることはできますか
-
はい、可能です。
特定のショップ様に限定してアプリを公開することができます。
- 自社のショップデータを基幹システムに流し込むためにAPIを使いたいのですが、利用は可能でしょうか。
アプリを他のショップに公開せず自社内だけで利用する予定です。 -
はい、ご利用可能です。
アプリを自社ショップのみ公開とすることができます。
- 入庫・出庫等の連携を行う予定で、御社APIへ頻繁にリクエストが飛ぶ可能性があるのですが、そもそもそういったアプリはNGでしょうか。
-
恐れ入りますが、レート制限を超えて大量のリクエストの送信については禁止しております。
レート制限、アクセス制限につきましては開発ガイドの制限範囲をご参照ください。
- テスト環境とリリース後の本番環境で異なるWebhookURLを指定することは可能でしょうか。
-
はい、可能です。
- テスト環境にて、インストールなどのWebhookURLは複数設定できるのでしょうか。
-
恐れ入りますが、WebhookURLは1種類につき1つの設定となります。
ただし、付け替えは可能ですので、ご変更が必要なタイミングでアプリ情報変更申請(テスト環境)よりご依頼いただければと存じます。
※アプリ情報変更申請(テスト環境)フォームは、アプリ開発申請の手続き完了メールに記載しております。
- アプリストアのようなものはありますか
-
はい、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時間となります。
- アプリ開発申請を行いましたが、その後どのように開発を進めれば良いでしょうか。
-
テスト環境でAPIリクエストやwebhook通知の確認を行い、開発を進めてください。
アプリ開発申請の手続き完了メールにて、テスト環境用のAPI接続情報をお送りしていますので、
テスト環境のテストショップにてダミーの商品情報などをご登録いただき、APIで取得いただく等のテストをしていただきながら開発を進めていただければと存じます。詳細は、APIリクエストをご確認ください。
開発が完了しましたらアプリ公開申請フォーム(手続き完了メール内に記載)よりご申請ください。
審査後、本番環境のAPI接続情報をお送りしますので、最終確認後にリリースという流れとなります。なお、APIリクエストに必要なtokenはwebhookで通知されますため、アプリを限定公開する場合であっても、インストールwebhookとアンインストールwebhookで通知を受け取れる必要がございますので、あらかじめご了承ください。