パラメータ共通事項

はじめに

本ページではパラメータの共通事項について説明します

機能毎の入出力パラメータは機能別入出力パラメータ一覧から参照して下さい

成功時以外の出力パラメータ

出力結果をレスポンスで返すAPIは、出力パラメータに必ず"result"があり処理ステータスを表します

resultの値 返却パラメータ 備考
success 呼び出したAPIにより結果が異なります
error 同時に「code」にエラー原因を特定する為のメッセージコード、「message」にエラーメッセージが設定されます メッセージコードとメッセージの一覧はこちらを参照下さい
redirect 同時に「code」に要リダイレクト(要再認証)原因を特定する為のメッセージコード、「message」にメッセージが設定されます この値を受け取った場合、ネクストエンジンに(再)ログインするためにuid・state取得にリダイレクトする必要があります。メッセージコードとメッセージの一覧はこちらを参照下さい

待機フラグについて

access_tokenを指定する全てのAPIに待機フラグ(wait_flag)が指定可能です。

メイン機能過負荷の場合、エラーにせず実行可能になるまで待機するか指定するフラグです。

データの状態により実施出来ない場合(例えば受注伝票更新APIで棚卸中、受注取込中の場合)は待機せずにエラーを返却します

wait_flagの値 動作 備考
1 メイン機能過負荷の場合、エラーにせず実行可能になるまで最大60分待機しAPIを実行します。

60分待っても過負荷であった場合、サーバー接続を確保出来るなら正常にAPIを実行します。

サーバー接続さえ確保出来ない状態の場合、003001のエラーを返却します。
こちらは高負荷な処理(バッチ処理、大量検索・大量更新)や、アプリ側の1連の処理を途切れさせたくない場合にご利用頂くことを想定しています。

企業情報取得などユーザーに即時レスポンスを返すべき処理ではご利用頂かない事を強く推奨致します。

(Ex:メイン機能過負荷の場合、アプリの起動やアプリ内の画面遷移に60分近く時間が掛かってしまう可能性があります)。

また必ずAPIが成功する事を保証するパラメータではない為、再開可能なようにアプリを設計して下さい。
1以外(省略時含む) メイン機能過負荷の場合、003002のエラーを返却します。 こちらはユーザーに即時レスポンスを返すべき処理で利用することを推奨致します。

アプリ側で「003002のエラーの場合、リトライする」よりも、"1"を指定し待機した方がより高速になります。

(実行可能になり次第、即時APIを実施する為。また極度に頻繁なリトライ処理を実施した場合はサーバーに負荷を与えたと判断する為)

カンマ区切りの指定について

値にカンマ、ダブルクォート、改行のいずれかを含む場合は、必ずダブルクォートで囲む必要があります

また値に含まれるダブルクォートは、ダブルクォートを2つ並べてエスケープする必要があります