アプリ開発

ネクストエンジン API の「アプリ開発」に関するよくある質問です。

アプリケーションの動作環境にはSSL認証されたサーバーが必要でしょうか？

はい。ネクストエンジンアプリの連携にはSSL認証された（httpsではじまる）URLでアクセス可能なサーバーが必要です。

アプリ環境にIP制限があるので、接続元(ネクストエンジンサーバ)のIPを知りたいです。

ネクストエンジンAPIの認証の流れは

クライアント → ネクストエンジンサーバ → クライアント → アプリなので、

(リダイレクト処理されるので)ネクストエンジンサーバーからアプリに直接アクセスすることはありません。接続元IP(ネクストエンジンサーバのIPアドレス)の考慮は必要ありません。

開発したアプリを公開する場合は環境を用意していただけるのでしょうか？

ネクストエンジンは、アプリが稼働するサーバを開発者に提供致しません。

アプリをWeb上で公開するためのサーバは、動作環境（開発/検証/本番）に関わらず、開発者が用意する必要がございます。

テスト環境用のデータはどうすれば用意できるでしょうか？

開発中アプリはテストメイン機能と紐付いています。

詳しくはこちらをご覧ください。

https://manual.next-engine.net/pf/pf017/

テスト環境と本番環境の切り替えはどのようにすればよいでしょうか？

以下ページを参照ください。 https://manual.next-engine.net/pf/pf022/

client_id, client_secretはアプリテスト環境とアプリ本番環境それぞれ別にありますので、

アプリ側で接続先を設定（切り替えて）していただく必要があります。

本番環境用、テスト環境用のclient_id, client_secretの確認はネクストエンジンTOP＞アプリを作る＞該当アプリの「詳細」ボタン「API」タブで確認できます。

作成したネクストエンジンアプリは、ローカル環境（PC）で動作検証できますか？

はい。ローカルでの動作検証は可能です。ローカル環境でのAPIご利用までの流れをご説明している記事がございますので、

こちらをご参考にしていただければ幸いです。

ネクストエンジンAPIの使い方

http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd

他の言語でのSDKの提供はありますか？

ありません。

現在、提供されているSDKはこちらを御覧ください。他の言語のSDKを開発された方がいらっしゃいましたら、ぜひコミュニティに貢献しましょう！弊社公認としてリファレンスに掲載させていただきます。

アプリを開発するにはネクストエンジンを契約する必要がありますか？

アプリ開発用のテスト環境(テストメイン機能)をご用意しております。

テスト環境のご利用料金は無料です。ぜひご利用ください。

ネクストエンジンAPIはバッチ（コマンドライン）での利用は可能ですか？

はい。実現は可能です。ただし、Webアプリケーションを想定した仕組みのため、いくつか工夫が必要です。

【前提】

・APIの利用には「アクセストークン」が必要

・アクセストークンを更新するには「リフレッシュトークン」が必要

・アクセストークンは24h、リフレッシュトークンは72hの有効期限がある

・有効期限が切れた場合はAPIの呼び出しに失敗する。ただし、リフレッシュトークンが有効期限内で

　あればアクセストークンの更新（トークンの再発行と有効期限の延長）が可能

APIリファレンスに詳細な情報がございますので合わせてご確認ください。

【対応方法】

・「アクセストークン」の取得には以下の2つのパターンがあります。

　a. ネクストエンジンIDとパスワードでの認証

　b. リフレッシュトークンを利用したアクセストークンの更新

１．少なくとも初回は必ずaの対応が必要なため、弊社から提供しておりますSDKなどをご利用いただき、

　　aの方法でアクセストークンとリフレッシュトークンを取得していただく

　　（アプリの「Redirect URI」にはlocalhostなど、お使いの環境から見えるURLを設定してください）

２．取得したアクセストークンとリフレッシュトークンを利用しAPIを呼び出す

３．有効期限が切れた場合はbの方法でアクセストークンを更新していただく

４．2に戻る

aの方法はブラウザとWebサーバーなど弊社サーバーから値を渡すための環境が必要ですが、

bの方法はバッチなどのプログラムが動かせる環境があれば実現可能かと思います。

【注意点】

・リフレッシュトークンの有効期限が切れた場合はaの方法でアクセストークンを再取得する必要があります。

　そのため前回起動から72h以内にはbの方法でアクセストークンの再取得が必要です。

・プラットフォームの画面からaに利用したネクストエンジンIDのユーザーのアプリの利用権限を変更した場合、

　アクセストークンが更新されるためAPIが呼び出せなくなります。

・アクセストークンはネクストエンジンIDごとに値が異なるため、どなたかユーザーと紐づくことになりますので

　API経由で更新したメイン機能の履歴がそのユーザーのものになる場合がございます。

各エンドポイントにおける、使用不可文字を教えてください。

ネクストエンジン(メイン機能)のマニュアルをご参照ください。

同一トークンによる並列リクエストをしたいのですが、懸念事項はありますでしょうか？

同一トークンによる並列リクエストはしないでください。

認証情報の有効期限がきれた場合、並列リクエストを行っているとエラーレスポンスが返却される可能性があります。

また、サーバの高負荷や大量リソース消費を生じさせるリクエストについては、アクセス制限を実施させていただく場合がありますのでご注意ください。開発時の注意事項

アプリ本番環境への繋ぐ方法とそのタイミングを知りたいです。

ネクストエンジンTOP＞アプリを作るにおいて、アプリ審査後、「販売開始」ボタンを押下すると、アプリ本番環境のclient_id、client_secretが利用できる状態になります。

上記のclient_id、client_secretを利用し、ネクストエンジンAPIを利用すると、本番メイン機能へのアクセスが可能になります。

予め、環境別にclient_id、client_secretを切り替えられるようにしておくとスムーズなリリースが可能になります。

「特定の企業に公開」アプリを開発する場合、アプリ利用企業とアプリ開発企業が異なる場合のアプリの作成方法を教えてください。

a.「アプリ開発企業にアプリ利用企業のユーザをゲスト招待する方法」と b.「アプリ利用企業にアプリ開発企業のユーザをゲスト招待する方法」があります。

【aの場合】

この場合はアプリ開発企業ユーザが、初回アプリ作成から販売開始まで行うことができます。

【bの場合】

ゲスト招待したアプリ開発企業のユーザにテストメイン機能、テストアプリの利用権限を付与し、アプリ開発を行うことになります。

ただし、この場合は初回アプリ作成をアプリ利用企業のユーザが作成する必要があります。(アプリを作成し、そのアプリの権限をゲストユーザに付与する)

利用企業、接続先メイン機能選択はアプリ利用企業ユーザのみ選択できます。

どちらの場合もアプリ販売開始後に、アプリ利用企業の権限設定(ネクストエンジンTOP＞設定＞アプリ＞利用ユーザ設定)を変更をすると、利用することができます。

エクセルVBAからネクストエンジンAPIを使って、在庫数変更などの処理を行いたいのですが、物理的に可能なのでしょうか？

VBAはSDKが用意されていないだけであり、他言語同様APIを問題なく使っていただけます。

ただしVBAのバージョン差による挙動やどのバージョンを使えば動作するかなどのサポートは一切ございませんのでご注意くださいませ。

過去時点の在庫数を取得することは可能ですか？

API 在庫入出庫履歴検索にて取得が可能です。

指定時間がある場合は指定日時以前の条件で取得した結果で一番新しいデータの更新後在庫数がその時点の在庫数になります

参考

入出庫履歴検索 (/api_v1_master_stockiohistory/search)

検索条件の比較演算子

各種検索APIのデータ取得順序について教えて下さい。

下記の通りです。

1）受注明細検索API

https://api.next-engine.org/api_v1_receiveorder_row/search

昇順：receive_order_row_receive_order_id （優先度１）

昇順：receive_order_row_no (優先度２)

2）受注オプション検索API

https://api.next-engine.org/api_v1_receiveorder_option/search

昇順：receive_order_id

3）在庫検索API

https://api.next-engine.org/api_v1_master_stock/search

昇順：stock_goods_id

4）商品マスターAPI

https://api.next-engine.org/api_v1_master_goods/search

昇順：goods_id

5）アップロードキュー検索

https://api.next-engine.org/api_v1_system_que/search

昇順：que_id”

どの商品がどの店舗と在庫連携しているか確認するAPIはありますか？

在庫連携を確認できるAPIはございません。

各店舗と在庫連携するためのモール商品一括登録をAPIにて行うことはできますか？

モール商品一括登録用はAPIにて登録いただくことができません。

仕入伝票の検索はAPIを利用することができますが、伝票の作成や操作はできますか？

仕入伝票に関する操作は、検索のみ可能です。また、現在追加の予定はございません。

公開アプリを「アプリで探す」にて検索する際「カテゴリで探す」より検索できるカテゴリはどのように付与すればよいでしょうか。

カテゴリ付与は、発売後にアプリの内容を鑑みてネクストエンジンの担当者が付与しております。開発者側にて付与することはできません。

在庫振り分けを使用して店舗ごとに連携する在庫数を変えている場合に、ネクストエンジンAPIを使用して店舗ごとの在庫数を取得することはできますか？

ネクストエンジンAPIでは振り分けられた在庫数を取得することはできません。

ネクストエンジンで使用不可な文字列を含めた状態で、受注伝票受注伝票更新APIを実行してみたところ、問題なく更新が行えました。API側では使用不可文字列の制限は特に行ってないということでしょうか。

API側でも以下のページにある使用不可な文字列のご利用については推奨しておりませんので、利用を避けるようにお願いいたします。　

　https://manual.next-engine.net/main/starter/str_overview/kiso_kyoutsuu/8…