FAQ一覧

#client_id・client_secret関連


Q. client_id、client_secretとはなんですか?

A. ネクストエンジンAPIのアプリごとに発行されるIDとパスワードのようなものです。

アプリ毎に異なる値が割り振られ、ネクストエンジンがアプリの識別に利用します。
認証情報のため、第3者へ漏らさないよう取扱にはご注意ください。


Q. 本番環境用のclient_id、client_secretはいつから利用可能になりますか?

A. アプリが「販売中」になったタイミングでご利用可能になります。

ご利用不可の状態だと、client_id、client_secretが
赤字に、利用可能な状態だと黒字になっていますのでご注意ください。

#access_token・refresh_token関連


Q. エラーが発生した場合access_tokenとrefresh_tokenは返ってきますか?

A. 返却されるメッセージコードによります。

resultがerrorの場合でも, 基本的には有効なaccess_token, refresh_tokenを返します。

ただし, リクエストされたaccess_token, refresh_tokenが不正の場合(エラーコード: 002002, 002004),
一部のシステムエラー(エラーコード: 999999)の場合は有効なaccess_token, refresh_tokenを返しません。


Q. ログイン画面を開かずに、access_tokenを取得する方法はありませんか?

A. 申し訳ございませんが、ネクストエンジンAPIはWebアプリケーションを想定した仕組みのため、初回は必ずログイン画面にてネクストエンジンIDとパスワードでの認証が必要になります。


Q. access tokenが有効期限切れ、refresh tokenが期限内という状態でリクエストした場合どうなりますか?

A. 初回のリクエストのみエラーにはならず、新しいaccess tokenとrefresh tokenが発行されます。
この時に発行されるaccess tokenとrefresh tokenを保持しておけば、以降のリクエストは正常レスポンスが返却されます。

ただ、この時のaccess tokenとrefresh tokenを保持せず、今までのaccess tokenとrefresh tokenでリクエストするとエラーレスポンス(002002: access_token[xxxxx]が不正です。)が返却されます。


Q. access_tokenの更新タイミングについて教えてください。

A. 認証の度に更新されるのではなく、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は任意のタイミングで更新できますか?

A. いいえ。任意のタイミングでの更新はできません。有効期限切れ後の初回リクエスト(いずれかのエンドポイントにリクエスト)時に更新されます。


Q. access_tokenとrefresh_tokenの構成要素を教えてください。

A. ともにランダムな文字列128桁になります。

#アプリ開発関連


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

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


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

A. ネクストエンジンAPIの認証の流れは
クライアント → ネクストエンジンサーバ → クライアント → アプリなので、
(リダイレクト処理されるので)ネクストエンジンサーバーからアプリに直接アクセスすることはありません。

接続元IP(ネクストエンジンサーバのIPアドレス)の考慮は必要ありません。


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

A. ネクストエンジンは、アプリが稼働するサーバを開発者に提供致しません。
アプリをWeb上で公開するためのサーバは、動作環境(開発/検証/本番)に関わらず、開発者が用意する必要がございます。


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

A. 開発中アプリはテストメイン機能と紐付いています。
詳しくはこちらをご覧ください。
http://manual.next-e.jp/how_use/make/


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

A. 以下ページを参照ください。

3.2.1.5. 「API」タブ
http://manual.next-e.jp/screen/make/new/tabb5/

client_id, client_secretはアプリテスト環境とアプリ本番環境それぞれ別にありますので、
アプリ側で接続先を設定(切り替えて)していただく必要があります。

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


Q. 作成したネクストエンジンアプリは、ローカル環境(PC)で動作検証できますか?

A. はい。ローカルでの動作検証は可能です。

ローカル環境でのAPIご利用までの流れをご説明している記事がございますので、
こちらをご参考にしていただければ幸いです。

ネクストエンジンAPIの使い方
http://qiita.com/hamee-dev/items/114aa0e45bf8d01861bd


Q. 他の言語でのSDKの提供はありますか?

A. ありません。
現在、提供されているSDKはこちらを御覧ください。

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


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

A. アプリ開発用のテスト環境(テストメイン機能)をご用意しております。
テスト環境のご利用料金は無料です。ぜひご利用ください。


Q. ネクストエンジンAPIはバッチ(コマンドライン)での利用は可能ですか?

A. はい。実現は可能です。

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

【前提】
・APIの利用には「アクセストークン」が必要
・アクセストークンを更新するには「リフレッシュトークン」が必要
・アクセストークンは24h、リフレッシュトークンは72hの有効期限がある
・有効期限が切れた場合はAPIの呼び出しに失敗する。ただし、リフレッシュトークンが有効期限内で
 あればアクセストークンの更新(トークンの再発行と有効期限の延長)が可能

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

【対応方法】
・「アクセストークン」の取得には以下の2つのパターンがあります。
 a. ネクストエンジンIDとパスワードでの認証
 b. リフレッシュトークンを利用したアクセストークンの更新

1.少なくとも初回は必ずaの対応が必要なため、弊社から提供しておりますSDKなどをご利用いただき、
  aの方法でアクセストークンとリフレッシュトークンを取得していただく
  (アプリの「Redirect URI」にはlocalhostなど、お使いの環境から見えるURLを設定してください)

2.取得したアクセストークンとリフレッシュトークンを利用しAPIを呼び出す
3.有効期限が切れた場合はbの方法でアクセストークンを更新していただく
4.2に戻る

aの方法はブラウザとWebサーバーなど弊社サーバーから値を渡すための環境が必要ですが、
bの方法はバッチなどのプログラムが動かせる環境があれば実現可能かと思います。

【注意点】
・リフレッシュトークンの有効期限が切れた場合はaの方法でアクセストークンを再取得する必要があります。
 そのため前回起動から72h以内にはbの方法でアクセストークンの再取得が必要です。
・プラットフォームの画面からaに利用したネクストエンジンIDのユーザーのアプリの利用権限を変更した場合、
 アクセストークンが更新されるためAPIが呼び出せなくなります。
・アクセストークンはネクストエンジンIDごとに値が異なるため、どなたかユーザーと紐づくことになりますので
 API経由で更新したメイン機能の履歴がそのユーザーのものになる場合がございます。


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


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

A. 同一トークンによる並列リクエストはしないでください。
認証情報の有効期限がきれた場合、並列リクエストを行っているとエラーレスポンスが返却される可能性があります。
また、サーバの高負荷や大量リソース消費を生じさせるリクエストについては、アクセス制限を実施させていただく場合がありますのでご注意ください。

開発時の注意事項


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

A. ネクストエンジンTOP>アプリを作るにおいて、アプリ審査後、「販売開始」ボタンを押下すると、アプリ本番環境のclient_id、client_secretが利用できる状態になります。
上記のclient_id、client_secretを利用し、ネクストエンジンAPIを利用すると、本番メイン機能へのアクセスが可能になります。
予め、環境別にclient_id、client_secretを切り替えられるようにしておくとスムーズなリリースが可能になります。


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

A. a.「アプリ開発企業にアプリ利用企業のユーザをゲスト招待する方法」と b.「アプリ利用企業にアプリ開発企業のユーザをゲスト招待する方法」があります。
【aの場合】
この場合はアプリ開発企業ユーザが、初回アプリ作成から販売開始まで行うことができます。
【bの場合】
ゲスト招待したアプリ開発企業のユーザにテストメイン機能、テストアプリの利用権限を付与し、アプリ開発を行うことになります。
ただし、この場合は初回アプリ作成をアプリ利用企業のユーザが作成する必要があります。(アプリを作成し、そのアプリの権限をゲストユーザに付与する)
利用企業、接続先メイン機能選択はアプリ利用企業ユーザのみ選択できます。


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

#審査・利用料金関連


Q. アプリの審査期間はどのくらいですか?

A. 1週間程度になります。


Q. ネクストエンジンAPIの利用には料金がかかりますか?

A. 販売形態が「すべての企業に公開」の場合は無料となります。
販売形態が「特定の企業に公開」の場合は利用量に伴って、料金が発生します。こちらの「特定の企業に公開」アプリ料金表をご参照ください。
(どちらもテストアプリでのネクストエンジンAPIの利用は無料です)


Q. 「特定の企業に公開」のアプリを2つ作った場合、利用料金はどうなりますか?

A. ご利用料金はアプリごとに算出されるので、
アプリが2つあれば2つ分のご利用料金を頂戴することとなります。

料金表に関してはこちらをご参照ください。


Q. 認証系エンドポイントに関しては、ネクストエンジンAPIの呼び出し回数としてカウントされるでしょうか?

A. 認証系エンドポイントに対するリクエストはカウントされません。(利用料金に含まれない)


Q. 現状のリクエスト回数と通信データ量を把握する方法はありますか?

A. ネクストエンジンTOP>アプリを作る>該当アプリ(「特定の企業に公開」アプリ)>操作>リクエスト履歴から日毎、月毎に閲覧可能(直近1年間のみ)です。


Q. リクエスト回数が月間10001回以上、通信データ量が月間6GB以上の場合は「要相談」となっていますが、どこに問い合わせればよいでしょうか?

A. サポートまでお問い合わせください。
こちらの「アプリに関するお問い合わせ先」をご参照ください。

#エラー関連


Q. アプリを開いたら 「このウェブページにはリダイレクトループが含まれています」と表示されます。原因はなんでしょうか?

A. access_tokenの有効期限が切れている場合があるため、
まずはご自身がログインされているか確認してください。


Q. ネクストエンジンサーバやメイン機能がメンテナンス中に、ネクストエンジンAPIを利用するとエラーが返ってきますか?

A. はい。エラーが返却されます。

メンテナンス状況によって、メッセージコード「002007」「003004」「003005」等が返却されます。
メッセージコードをご参照ください。


Q. 504 GATEWAY_TIMEOUT エラーの原因はなにが考えられますか?

A. 504 GATEWAY_TIMEOUTの原因は複数考えられるため断定はできませんが、アプリからネクストエンジンAPIへの接続がタイムアウトにより切れた可能性があります。
タイムアウトの要因も単純に処理に時間がかかりタイムアウトとなった、お客様がアプリを動作させているサーバー環境のタイムアウトの設定がAPIサーバーのタイムアウトの設定よりも短かったなどが考えられます。
APIサーバーやネクストエンジンメイン機能が高負荷により一時的にレスポンスが遅くなっている場合もありますので、時間をおいてアクセスしていただくと解決することもあるかと思います。
継続してタイムアウトが発生する場合はお手数ですが再度お問い合わせをお願いいたします。


Q. uid、state取得エンドポイントをリクエストすると、「アプリの連携に失敗しました -指定したアプリがみつかりませんでした-」というエラー画面が表示されます。対処方法を教えてください。

A. 該当ユーザにアプリの利用権限がついていない可能性があります。
ネクストエンジンTOP>設定>アプリ>利用ユーザー設定にて、ネクストエンジンAPIを利用するユーザの利用許可をしていただいた上で、再度ご確認ください。
権限はテスト環境、本番環境毎に設定できます。アプリ環境をご確認の上、利用権限設定を行ってください。

#受注関連


Q. ネクストエンジンAPIで受注明細を更新し、更新したデータをネクストエンジンAPIで取得しようとした場合、即時更新した内容がネクストエンジンAPIで取得できますか?

A. はい。即時反映したものが取得できます。

※ 但し、非同期で更新される機能があります。
・受注一括登録
・商品マスタ予約一括登録


Q. 受注状態区分エンドポイントで取得できる区分のID及び名称は固定値でしょうか?

A. はい。受注状態区分のIDと名称は固定値になります。
管理画面などでのカスタマイズは不可となります。


Q. 「受注一括登録フォーマットパターン」と「受注一括登録パターン」について教えてください。

A. ネキストエンジンAPIでは「受注一括登録フォーマットパターン」と「受注一括登録パターン」を区別して扱っております。
受注伝票アップロードエンドポイントの「receive_order_upload_pattern_id」に入力する値は登録対象の「受注一括登録パターンID」になります。
各「受注一括登録フォーマットパターンID」を条件にして、受注一括登録パターン情報取得エンドポイントから、「受注一括登録パターンID」を取得することができます。

受注一括登録パターン情報取得


Q. 受注伝票における、受注状態の変更方法を教えてください。

A. ネクストエンジン(メイン機能)では確認処理や入金登録処理、出荷処理などを行った場合に受注状態区分が変わります。(手動で変更することはできません)
ネクストエンジンAPIでは受注伝票納品書印刷済みエンドポイント、受注伝票出荷確定処理エンドポイントなどで受注状態区分が自動で変わります。

#発注関連


Q. 発注伝票を取得・更新するためのエンドポイントはありますか?

A. いいえ。現在、発注伝票系のエンドポイントは提供しておりません。

#商品関連


Q. 在庫更新エンドポイントはありますか?商品在庫数の更新方法を教えてください。

A. 在庫更新は商品マスタアップロードエンドポイント( https://developer.next-engine.com/api/api_v1_master_goods/upload )にて行うことができます。

商品在庫数は、実数ではなく加算数または減算数を設定します。
実数で更新したい場合は、一度現在の在庫数を取得し更新したい在庫数の差分で更新することになります。
ex. 現在の在庫数が「6」、更新したい在庫の実数が「4」、在庫数は「-2」で設定する

更新するCSVフィールド名は下記の通りです。
在庫数: zaiko_su
予約在庫数: yoyaku_zaiko_su

商品マスタアップロードエンドポイントで利用するdata(CSV)の仕様はネクストエンジン(メイン機能)のルールと同様になりますので、こちらをご参照ください。


Q. 商品ページ(β版)のAPI対応の予定はありますか?

A. 商品ページ(β版)が正式版となりましたら、APIについても対応する予定です。
現時点でβ版終了日は未定となっております。


Q. 在庫マスタ検索(/api_v1_master_stock/search)エンドポイントにおいて、where句パラメータのIN句に記述できるデータの上限数はいくつになりますでしょうか?

A. 上限は1000個になります。


Q. 商品マスタアップロード(/api_v1_master_goods/upload)エンドポイントにおいて、パラメータのCSV部分に改行区切りでセットできるレコード数に上限はありますでしょうか?

A. 上限はございませんが、量が多くなる場合は、data_typeをgzにして、圧縮ファイルをアップロードするようにしてください。
データ量によってはアップロードエラーになる場合があります。


Q. 商品マスタアップロードエンドポイントに関して、メイン機能へのアップロードに失敗したがsuccessで返却される仕様について教えてください。

A. 商品データアップロードエンドポイントのレスポンス内容はメイン機能の更新結果ではなく、ファイルアップロードが成功したか否かの結果になります。
メイン機能の更新処理の結果については、アップロードキュー検索API(エンドポイント /api_v1_system_que/search)を参照してください。


Q. 返品処理について教えてください。

A. 商品マスタアップロードエンドポイント(/api_v1_master_goods/upload)を利用する事により返品処理を行う事ができます。
在庫数の加算/減算値(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. メイン機能において、汎用店舗で在庫連携するにはどうすればよいですか?

A. ネクストエンジンマニュアルに在庫連携APIの仕様書がありますので
こちらをご参照いただければと思います。

http://manual.ec-doc.net/startup/hanyo/
「設定に関する資料はこちらからダウンロードしてください」からダウンロードお願いします。

また、本Developer Networkのコミュニティでは、ネクストエンジンAPI関連以外は受け付けておりません。お問い合わせ等はサポートまでご連絡ください。