SDKについて

はじめに

SDKは、ネクストエンジンAPIの認証処理を内包している為、新たに認証処理を開発する必要がありません

必須パラメータを指定した後、直接リクエストURLを指定してデータアクセスを開始出来ます

SDKの必須パラメータ

パラメータ名 設定値 備考
client_id ネクストエンジンの「アプリを作る」->「API」->「クライアントID」を指定します
client_secret ネクストエンジンの「アプリを作る」->「API」->「クライアントシークレット」を指定します

提供SDKの一覧

プログラミング言語 SDKダウンロード 備考
PHP ダウンロード
Java ダウンロード Java SDKは、JSONデータのパースにJacksonを使用しています

PHP SDKマニュアル

PHP SDKは、PHP 5.4以上(7系を除く)で動作確認をしています。
ファイル名 説明 備考
neApiClient.php SDK本体です。このファイルは修正しないで下さい neApiClientクラス参照
api_find.php サンプル(メイン機能と連携するアプリ)です 利用者情報取得、マスタ情報取得するサンプルです。マスタ情報取得のアクセス情報を「許可する」にネクストエンジンの「アプリを作る」->「API」で設定する必要があります
api_storage.php サンプル(メイン機能と連携するアプリ)です ストレージAPIを利用するサンプルです。ネクストエンジンストレージ情報取得・ネクストエンジンストレージ情報更新のアクセス情報を「許可する」にネクストエンジンの「アプリを作る」->「API」で設定する必要があります
api_upload.php サンプル(メイン機能と連携するアプリ)です 商品マスタ予約一括登録をするサンプルです。マスタ情報更新・マスタ情報取得のアクセス情報を「許可する」にネクストエンジンの「アプリを作る」->「API」で設定する必要があります
login_only.php サンプル(ネクストエンジンログインのみのアプリ)です ネクストエンジンログインに成功した際に取得可能な情報はこちらからご確認下さい
neApiClientクラス
メソッド 説明 備考
__construct インスタンス生成時にSDKの必須パラメータを指定します。バッチ(非同期)ではない場合は、必ずredirect_uriも指定して下さい バッチ処理をする場合は、redirect_uriにNULL指定し、access_token及びrefresh_tokenに最後に認証した時の値を指定して下さい。詳細はSDKのソースを参照下さい
apiExecute 「メイン機能と連携するアプリ」の場合、本メソッドを用います APIのパス、パラメータはリクエストURL一覧を参照下さい
neLogin 「ネクストエンジンログインのみのアプリ」の場合、本メソッドを用います
apiExecuteNoRequiredLogin ネクストエンジンログインが不要なAPIの場合、本メソッドを用います。既にネクストエンジンログインが完了している場合でも本メソッドを使用して下さい
decompressionFile ストレージAPIでファイルダウンロード時に圧縮とエンコードされているデータを展開する場合に本メソッドを用います。 展開したファイルの保存は別途処理が必要です。詳細はSDKに同梱されているサンプルプログラムを参照下さい。

JAVA SDKマニュアル

JavaSDKはJDK 1.6.0_45でビルドしています。これより前のJDKはサポート対象外です。
ファイル名 説明 備考
sdk.java.jar SDK本体です neApiClientクラス参照。本jarファイルにはソース・ファイルである*.javaも含まれています
jackson-annotations-2.2.3.jar SDKが使用しているライブラリです SDKを使用する為に、sdk.java.jarとこれらの.jarファイルもライブラリとして取り込む必要があります
jackson-core-2.2.3.jar
jackson-databind-2.2.3.jar
neApiClientクラス
メソッド 説明 備考
NeApiClient インスタンス生成時にSDKの必須パラメータを指定します。バッチ(非同期)ではない場合は、必ずredirect_uriも指定して下さい バッチ処理をする場合は、access_token及びrefresh_tokenのみ指定し、最後に認証した時の値を指定して下さい。詳細はSDKのソースを参照下さい
apiExecute 「メイン機能と連携するアプリ」の場合、本メソッドを用います APIのパス、パラメータはリクエストURL一覧を参照下さい
neLogin 「ネクストエンジンログインのみのアプリ」の場合、本メソッドを用います
apiExecuteNoRequiredLogin ネクストエンジンログインが不要なAPIの場合、本メソッドを用います。既にネクストエンジンログインが完了している場合でも本メソッドを使用して下さい