#client_id・client_secret関連
Q. client_id、client_secretとはなんですか？
アプリ毎に異なる値が割り振られ、ネクストエンジンがアプリの識別に利用します。
認証情報のため、第3者へ漏らさないよう取扱にはご注意ください。
Q. 本番環境用のclient_id、client_secretはいつから利用可能になりますか？
ご利用不可の状態だと、client_id、client_secretが
赤字に、利用可能な状態だと黒字になっていますのでご注意ください。
Q. client_id、client_secretはどこから確認すればよいでしょうか？
同じ画面内に本番環境設定とテスト環境設定があります
[本番環境設定]の下に表示されている[テスト環境設定]の「client_id」、「client_secret」をご利用ください
Q. テスト環境にAPI接続するためのclient_id、client_secretはどの様に発行して頂けるのでしょうか
テスト環境はリダイレクトURLを設定していただきますと、
クライアントIDおよびクライアントシークレットが自動で生成されます。
本番環境に関しましては、審査が必要となってまいります。
#access_token・refresh_token関連
Q. エラーが発生した場合access_tokenとrefresh_tokenは返ってきますか？
resultがerrorの場合でも, 基本的には有効なaccess_token, refresh_tokenを返します。
ただし, リクエストされたaccess_token, refresh_tokenが不正の場合(エラーコード: 002002, 002004),
一部のシステムエラー(エラーコード: 999999)の場合は有効なaccess_token, refresh_tokenを返しません。
Q. ログイン画面を開かずに、access_tokenを取得する方法はありませんか？
Q. access tokenが有効期限切れ、refresh tokenが期限内という状態でリクエストした場合どうなりますか？
この時に発行されるaccess tokenとrefresh tokenを保持しておけば、以降のリクエストは正常レスポンスが返却されます。
ただ、この時のaccess tokenとrefresh tokenを保持せず、今までのaccess tokenとrefresh tokenでリクエストするとエラーレスポンス(002002: access_token[xxxxx]が不正です。)が返却されます。
Q. access_tokenの更新タイミングについて教えてください。
例えばaccess_tokenの有効期限が10:00までだった場合、以下のようになります。
a. 09:50 アクセストークンAでリクエスト
b. 10:01 アクセストークンAでリクエスト ← ここで更新されたトークン情報(アクセストークンB)が返却されます。
c. 10:02 アクセストークンBでリクエスト ← bで返却された新しいトークン情報を利用して、リクエストを行ってください。
レスポンスの度にDBなどの永続化されたデータに保存、リクエストの際はそのデータを毎回参照し、アプリの画面など別のプロセスでトークンの更新があっても問題ないように実装いただくようにしてください。
Q. access_token, reflesh_tokenは任意のタイミングで更新できますか？
Q. access_tokenとrefresh_tokenの構成要素を教えてください。
Q. アクセストークン値は発行からどのくらい継続されますか？
トークン値更新後の最初のリクエストにてアクセストークンとリフレッシュトークンを渡していただければ、新しいアクセストークンとリフレッシュを取得できます。
なお、リフレッシュトークンは72時間継続されます。
#アプリ開発関連
Q. アプリケーションの動作環境にはSSL認証されたサーバーが必要でしょうか？
Q. アプリ環境にIP制限があるので、接続元(ネクストエンジンサーバ)のIPを知りたいです。
クライアント → ネクストエンジンサーバ → クライアント → アプリなので、
(リダイレクト処理されるので)ネクストエンジンサーバーからアプリに直接アクセスすることはありません。
接続元IP(ネクストエンジンサーバのIPアドレス)の考慮は必要ありません。
Q. 開発したアプリを公開する場合は環境を用意していただけるのでしょうか？
アプリをWeb上で公開するためのサーバは、動作環境（開発/検証/本番）に関わらず、開発者が用意する必要がございます。
Q. テスト環境用のデータはどうすれば用意できるでしょうか？
Q. テスト環境と本番環境の切り替えはどのようにすればよいでしょうか？
https://manual.next-engine.net/pf/pf022/
client_id, client_secretはアプリテスト環境とアプリ本番環境それぞれ別にありますので、
アプリ側で接続先を設定（切り替えて）していただく必要があります。
本番環境用、テスト環境用のclient_id, client_secretの確認はネクストエンジンTOP＞アプリを作る＞該当アプリの「詳細」ボタン「API」タブで確認できます。
Q. 作成したネクストエンジンアプリは、ローカル環境（PC）で動作検証できますか？
ローカル環境でのAPIご利用までの流れをご説明している記事がございますので、
こちらをご参考にしていただければ幸いです。
ネクストエンジンAPIの使い方
http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd
現在、提供されているSDKはこちらを御覧ください。
他の言語のSDKを開発された方がいらっしゃいましたら、ぜひコミュニティに貢献しましょう！弊社公認としてリファレンスに掲載させていただきます。
Q. アプリを開発するにはネクストエンジンを契約する必要がありますか？
テスト環境のご利用料金は無料です。ぜひご利用ください。
Q. ネクストエンジン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経由で更新したメイン機能の履歴がそのユーザーのものになる場合がございます。
Q. 各エンドポイントにおける、使用不可文字を教えてください。
Q. 同一トークンによる並列リクエストをしたいのですが、懸念事項はありますでしょうか？
認証情報の有効期限がきれた場合、並列リクエストを行っているとエラーレスポンスが返却される可能性があります。
また、サーバの高負荷や大量リソース消費を生じさせるリクエストについては、アクセス制限を実施させていただく場合がありますのでご注意ください。
Q. アプリ本番環境への繋ぐ方法とそのタイミングを知りたいです。
上記のclient_id、client_secretを利用し、ネクストエンジンAPIを利用すると、本番メイン機能へのアクセスが可能になります。
予め、環境別にclient_id、client_secretを切り替えられるようにしておくとスムーズなリリースが可能になります。
Q. 「特定の企業に公開」アプリを開発する場合、アプリ利用企業とアプリ開発企業が異なる場合のアプリの作成方法を教えてください。
【aの場合】
この場合はアプリ開発企業ユーザが、初回アプリ作成から販売開始まで行うことができます。
【bの場合】
ゲスト招待したアプリ開発企業のユーザにテストメイン機能、テストアプリの利用権限を付与し、アプリ開発を行うことになります。
ただし、この場合は初回アプリ作成をアプリ利用企業のユーザが作成する必要があります。(アプリを作成し、そのアプリの権限をゲストユーザに付与する)
利用企業、接続先メイン機能選択はアプリ利用企業ユーザのみ選択できます。
どちらの場合もアプリ販売開始後に、アプリ利用企業の権限設定(ネクストエンジンTOP＞設定＞アプリ＞利用ユーザ設定)を変更をすると、利用することができます。
Q. エクセルVBAからネクストエンジンAPIを使って、在庫数変更などの処理を行いたいのですが、物理的に可能なのでしょうか？
ただしVBAのバージョン差による挙動やどのバージョンを使えば動作するかなどのサポートは一切ございませんのでご注意くださいませ。
指定時間がある場合は指定日時以前の条件で取得した結果で一番新しいデータの更新後在庫数がその時点の在庫数になります
参考
https://developer.next-engine.com/api/api_v1_master_stockiohistory/search
https://developer.next-engine.com/api/param/operator_compare
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"
Q.どの商品がどの店舗と在庫連携しているか確認するAPIはありますか？
Q.各店舗と在庫連携するためのモール商品一括登録をAPIにて行うことはできますか？
Q.仕入伝票の検索はAPIを利用することができますが、伝票の作成や操作はできますか？
Q.公開アプリを「アプリで探す」にて検索する際「カテゴリで探す」より検索できるカテゴリはどのように付与すればよいでしょうか。
Q.在庫振り分けを使用して店舗ごとに連携する在庫数を変えている場合に、ネクストエンジンAPIを使用して店舗ごとの在庫数を取得することはできますか？
Q.ネクストエンジンで使用不可な文字列を含めた状態で、受注伝票受注伝票更新APIを実行してみたところ、問題なく更新が行えました。API側では使用不可文字列の制限は特に行ってないということでしょうか。
https://manual.next-engine.net/main/starter/str_overview/kiso_kyoutsuu/8...
#審査・利用料金関連
販売形態が「特定の企業に公開」の場合は利用量に伴って、料金が発生します。こちらの「特定の企業に公開」アプリ料金表をご参照ください。
(どちらもテストアプリでのネクストエンジンAPIの利用は無料です)
Q. 「特定の企業に公開」のアプリを２つ作った場合、利用料金はどうなりますか？
アプリが2つあれば2つ分のご利用料金を頂戴することとなります。
料金表に関してはこちらをご参照ください。
Q. 認証系エンドポイントに関しては、ネクストエンジンAPIの呼び出し回数としてカウントされるでしょうか？
・NEログインuid・state取得(/users/sign_in/)
・NEログインaccess_token取得(/api_neauth)
・アプリ利用企業一覧（/api_app/company）
Q. 現状のリクエスト回数と通信データ量を把握する方法はありますか？
Q. リクエスト回数が月間10001回以上、通信データ量が月間6GB以上の場合は「要相談」となっていますが、どこに問い合わせればよいでしょうか？
こちらの「アプリに関するお問い合わせ先」をご参照ください。
Q. APIの呼び出し回数が現状でどれほど計上されているかがわかりますでしょうか。
審査通過後、本番環境での運用になった場合から課金されることになります.
Q. ネクストエンジンのAPIを利用するにあたって、データ通信料がどれくらいになるか見積もりを取りたいと考えております。APIで取得していますデータ量の計算方法ってございますでしょうか。
Q. サーバー負荷による更新エラーなどでアクセストークンが更新されないケースはありますでしょうか？エラーコードは002002以外になるのでしょうか。
https://developer.next-engine.com/api/param/message
「NEログインaccess_token取得」エンドポイントをご利用の場合は、以下の分類のメッセージが返ってくる可能性がございます。
・共通
・AccessToken取得
・API共通処理(ネクストエンジン)
・API共通処理(メイン機能)
・例外
#エラー関連
Q. アプリを開いたら 「このウェブページにはリダイレクトループが含まれています」と表示されます。原因はなんでしょうか？
まずはご自身がログインされているか確認してください。
Q. ネクストエンジンサーバやメイン機能がメンテナンス中に、ネクストエンジンAPIを利用するとエラーが返ってきますか？
メンテナンス状況によって、メッセージコード「002007」「003004」「003005」等が返却されます。
メッセージコードをご参照ください。
Q. 504 GATEWAY_TIMEOUT エラーの原因はなにが考えられますか？
タイムアウトの要因も単純に処理に時間がかかりタイムアウトとなった、お客様がアプリを動作させているサーバー環境のタイムアウトの設定がAPIサーバーのタイムアウトの設定よりも短かったなどが考えられます。
APIサーバーやネクストエンジンメイン機能が高負荷により一時的にレスポンスが遅くなっている場合もありますので、時間をおいてアクセスしていただくと解決することもあるかと思います。
継続してタイムアウトが発生する場合はお手数ですが再度お問い合わせをお願いいたします。
Q. uid、state取得エンドポイントをリクエストすると、「アプリの連携に失敗しました -指定したアプリがみつかりませんでした-」というエラー画面が表示されます。対処方法を教えてください。
ネクストエンジンTOP＞設定＞アプリ＞利用ユーザー設定にて、ネクストエンジンAPIを利用するユーザの利用許可をしていただいた上で、再度ご確認ください。
権限はテスト環境、本番環境毎に設定できます。アプリ環境をご確認の上、利用権限設定を行ってください。
Q. GETリクエストをuid・state取得エンドポイントに送ったところ、HTMLログインページが返ってきました。これは正常なレスポンスですか？
#受注関連
Q. ネクストエンジンAPIで受注明細を更新し、更新したデータをネクストエンジンAPIで取得しようとした場合、即時更新した内容がネクストエンジンAPIで取得できますか？
※ 但し、非同期で更新される機能があります。
・受注一括登録
・商品マスタ予約一括登録
Q. 受注状態区分エンドポイントで取得できる区分のID及び名称は固定値でしょうか？
管理画面などでのカスタマイズは不可となります。
Q. 「受注一括登録フォーマットパターン」と「受注一括登録パターン」について教えてください。
受注伝票アップロードエンドポイントの「receive_order_upload_pattern_id」に入力する値は登録対象の「受注一括登録パターンID」になります。
各「受注一括登録フォーマットパターンID」を条件にして、受注一括登録パターン情報取得エンドポイントから、「受注一括登録パターンID」を取得することができます。
Q. 受注伝票における、受注状態の変更方法を教えてください。
ネクストエンジンAPIでは受注伝票納品書印刷済みエンドポイント、受注伝票出荷確定処理エンドポイントなどで受注状態区分が自動で変わります。
https://developer.next-engine.com/api/api_v1_receiveorder_base/upload
Q. 印刷待ち・印刷済みの受注状態の伝票をまとめて出荷完了に移動させることは可能ですか？
更新の際は、出荷確定処理API(/api_v1_receiveorder_base/shipped)をご利用ください。
【参考ページ】
https://developer.next-engine.com/api/api_v1_receiveorder_base/shipped
Q.1,000件以上の受注伝票をAPIでデータ更新したいです。ネクストエンジン側で連続したリクエストに対するアクセス制限は設けていますか？
・高負荷な処理(バッチ処理、大量検索・大量更新)や、アプリ側の1連の処理を途切れさせたくない場合にはwait_flagの値を1で設定してください。
ユーザーに即時レスポンスを返すべき処理ではご利用いただかないことを強く推奨致します。
また必ずAPIが成功する事を保証するパラメータではない為、再開可能なようにアプリを設計して下さい。
wait_flagについてはこちらをご参照ください。
https://developer.next-engine.com/api/param/common
・特定企業にのみ公開アプリの場合はAPI呼び出し回数によって料金が変わるのでご注意ください。
料金についてはこちらをご参照ください。
https://manual.next-engine.net/pf/pf015/
Q.受注伝票の「伝票番号(receive_order_option_receive_order_id)」は、順番に増えていく番号という認識であっていますか？最大値はありますか？
Q.APIを通して確認待ちステータスの注文を次のステップ(印刷日待など)に変更したい場合、受注状態区分を印刷日待にアップデートしてから転送する認識で問題ないでしょうか。
参照時と更新時の仕様が違うため、ご注意くださいませ。
参照時：
0:確認不要
1:確認必要
2:確認済み
更新時：
0：確認待ちのチェックを外す
1：確認待ちのチェックをつける
Q.APIを通して受注状態区分のアップデートは可能でしょうか。 例）印刷完了→確認待ち、確認待ち→発送完了
受注伝票納品書印刷済み(エンドポイント /api_v1_receiveorder_base/receipted) 印刷済み状態へ
受注伝票出荷確定処理(エンドポイント /api_v1_receiveorder_base/shipped) 出荷済み状態へ
確認待ち→発送完了につきましては、受注伝票更新(エンドポイント /api_v1_receiveorder_base/update)の確認チェック区分の更新にて状態が遷移できます。
注意事項としまして、前の状態へ遡るような、APIの提供はございません。
新規データ作成後、更新がなかった場合、①ではNULLもしくは明細の作成日、②では明細の作成日が返却されます。それ以外の違いはございません。
③を使っていただくと、受注伝票と受注明細の最終更新日を比較し、後に更新された日時を取得していただけます。
補足になりますが、①と②に関して、今回のような指定された日時以降のデータを取得したい場合は、②を利用するようにして下さい。
①最終更新日 receive_order_row_last_modified_date
②最終更新日 receive_order_row_last_modified_null_safe_date
③受注伝票・受注明細の最終更新日 receive_order_row_last_modified_newest_date
検索条件を複数指定した場合、全ての条件がかつ(AND)となります
参考：https://developer.next-engine.com/api/api_v1_receiveorder_base/search
Q.APIにて過去受注の検索を行う場合、どの程度過去まで遡って検索することができるのでしょうか。
受注伝票が存在する限り、遡って検索することができます。
Q.受注伝票情報を検索する時、受注状態が変更された受注のみ検索して持ってくることは可能でしょうか。
Q.クレジットカードの名義人と有効期限は取得できるのでしょうか。また、取得できる場合フィールド名はあるのでしょうか。
API経由であれば、一括アップロードを使用し受注伝票を更新すると現在の日時で更新されます。
メイン機能であれば、例えば出荷確定処理や納品書ダウンロード、受注伝票詳細画面などで変更が行われた場合現在の日時で更新されます。
#発注関連
Q. 発注伝票を取得・更新するためのエンドポイントはありますか？
Q. APIから、仕入先マスタに新しく仕入先を登録することは可能でしょうか。
#商品関連
Q. 在庫更新エンドポイントはありますか？商品在庫数の更新方法を教えてください。
商品在庫数は、実数ではなく加算数または減算数を設定します。
実数で更新したい場合は、一度現在の在庫数を取得し更新したい在庫数の差分で更新することになります。
ex. 現在の在庫数が「6」、更新したい在庫の実数が「4」、在庫数は「-2」で設定する
更新するCSVフィールド名は下記の通りです。
在庫数: zaiko_su
予約在庫数: yoyaku_zaiko_su
商品マスタアップロードエンドポイントで利用するdata(CSV)の仕様はネクストエンジン(メイン機能)のルールと同様になりますので、こちらをご参照ください。
現時点でβ版終了日は未定となっております。
Q. 在庫マスタ検索(/api_v1_master_stock/search)エンドポイントにおいて、where句パラメータのIN句に記述できるデータの上限数はいくつになりますでしょうか？
Q. 商品マスタアップロード(/api_v1_master_goods/upload)エンドポイントにおいて、パラメータのCSV部分に改行区切りでセットできるレコード数に上限はありますでしょうか？
データ量によってはアップロードエラーになる場合があります。
Q. 商品マスタアップロードエンドポイントに関して、メイン機能へのアップロードに失敗したがsuccessで返却される仕様について教えてください。
メイン機能の更新処理の結果については、アップロードキュー検索API(エンドポイント /api_v1_system_que/search)を参照してください。
在庫数の加算/減算値(zaiko_su)で返品数を設定し、入出庫履歴の事由(nyusyukko_riyu)に返品理由を設定します。
エンドポイントについてはこちらをご覧ください。
https://developer.next-engine.com/api/api_v1_master_goods/upload
アップロード用のcsvファイルについてはこちらをご覧ください。
http://manual.ec-doc.net/operation/operation-tips/zaiko-tips/k003/
Q. APIを利用して商品マスタに商品画像の登録はできますか？
Q商品を一括で新規登録する際は、どのような形式でAPIにパラメータを渡せばいいのでしょうか？
ヘッダー、各商品のパラメータごとにCSVの改行コードを挿入する感じでしょうか？
Q.「受注分類タグ」によりステータスを「確認待ち」に自動遷移させることは可能でしょうか。
Q.在庫数を変更する際に、加算・減算ではなく実数による上書きは可能でしょうか。
Q.一般的にはAPIで更新後、手動で「対象」にチェックを入れてページ作成、アップロードを行うのでしょうか？
Q.APIでは、商品マスタは商品コードから参照できますが、セット商品マスタはセット商品コードから参照できないのでしょうか。
#その他
Q. メイン機能において、汎用店舗で在庫連携するにはどうすればよいですか？
こちらをご参照いただければと思います。
http://manual.ec-doc.net/startup/hanyo/
「設定に関する資料はこちらからダウンロードしてください」からダウンロードお願いします。
また、本Developer Networkのコミュニティでは、ネクストエンジンAPI関連以外は受け付けておりません。お問い合わせ等はサポートまでご連絡ください。