API_SERVER_HOST
API_SERVER_HOST
Nextengine API SDK(http://api.next-e.jp/).
__construct(string $client_id, string $client_secret, string $redirect_uri = NULL, string $access_token = NULL, string $refresh_token = NULL) : void
インスタンス生成時、実行環境に合わせた値を引数に指定して下さい。
redirect_uriの説明： まだ認証していないユーザーがアクセスした場合(ネクストエンジンログインが必要な場合)、 本SDKが自動的にネクストエンジンのログイン画面にリダイレクトします（ユーザーには認証画面が表示される）。 ユーザーが認証した後、ネクストエンジンサーバーから認証情報と共にアプリケーションサーバーに リダイレクトします。その際のアプリケーションサーバーのリダイレクト先uriです。
redirect_uriの省略又はNULL指定について： 通常のWebアプリケーションの場合は、必ず指定して下さい。 NULLにするのは、一度Webアプリケーションで認証した後、バッチ等で非同期にAPIを実行する場合のみです。 NULLにし認証の有効期限が切れた場合(resultがRESULT_REDIRECT)、SDK内部で自動的にリダイレクトせず 結果はredirectのまま正常終了しません（認証の有効期限が切れた場合は、再度Web経由で認証の必要あり）。
access_tokenとrefresh_tokenの説明： バッチ等で非同期にAPIを実行する場合のみ、認証した状態を保持する為に必要です。
access_tokenとrefresh_tokenの省略(NULL指定)について： 通常のWebアプリケーションの場合は、省略して下さい。 指定するのは、一度Webアプリケーションで認証した後、バッチ等で非同期にAPIを実行する場合のみです。 指定する値は、最後にapiExecute又はneLogin呼び出し後の同名のメンバ変数の値です。 この値を初回ログイン時などにDBに保存しておき、バッチではその値を元に処理を実行することを想定しています。 注意：この値はユーザー毎(uid毎)に管理する必要があります。別のユーザーの値を指定してSDKを実行すると 他ユーザーの情報にアクセスしてしまうため、厳重にご注意をお願いします。
| string | $client_id | クライアントID。 |
| string | $client_secret | クライアントシークレット。 |
| string | $redirect_uri | ヘッダーコメント参照。 |
| string | $access_token | 同上。 |
| string | $refresh_token | 同上。 |
apiExecute(string $path, array $api_params = array(), string $redirect_uri = NULL) : array
ネクストエンジンログインを実施し、かつAPIを実行し、結果を返します。
| string | $path | 呼び出すAPIのパスです。/から指定して下さい。 |
| array | $api_params | 呼び出すAPIの必要に応じてパラメータ(連想配列)です。 パラメータが不要な場合、省略又はNULLを指定して下さい。 |
| string | $redirect_uri | インスタンスを作成した後、リダイレクト先を変更したい 場合のみ設定して下さい。 |
実行結果。内容は呼び出したAPIにより異なります。
neLogin(string $redirect_uri = NULL) : array
ネクストエンジンログインのみ実行します。 既にログインしている場合、ログイン後の基本情報を返却します。 まだログインしていない場合、ネクストエンジンログイン画面にリダイレクトされ、 正しくログインした場合、$redirect_uriにリダイレクトされます。 リダイレクト先で、再度neLoginを呼ぶ事で、ログイン後の基本情報を返却します。
| string | $redirect_uri | インスタンスを作成した後、リダイレクト先を変更したい 場合のみ設定して下さい。 |
NE APIのログイン後の基本情報。
setUidAndState() : void
メンバ変数にuidとstateを設定します。
1.NEからアプリを起動した場合。 uidとstateがGETパラメータに渡ってくる為、メンバ変数に設定します。 2.直接アプリを起動した場合。 uidとstateがGETパラメータに渡ってこない為、NEに認証に行きます(NEサーバーへリダイレクト)。 以下のようにユーザーの認証が終わると本サーバーにNEサーバーからリダイレクトされます。 2.1.起動したユーザーが既にNEログイン済みの場合。 認証画面を表示せずに$redirect_uriにリダイレクトされます。 2.2.起動したユーザーがまだNEログインしていない場合。 認証画面を表示して$redirect_uriにリダイレクトされます。