NEログインuid・state取得
リクエストURL
Section titled “リクエストURL”ホスト
https://base.next-engine.org
エンドポイント
/users/sign_in/
リファレンス内容
Section titled “リファレンス内容”uid・state取得について
Section titled “uid・state取得について”本APIはSDKを用いず、アプリから直接HTTP(S)通信を用いて認証してAPIを使う方向けの資料です
入力パラメータはGET、出力パラメータは入力パラメータで指定したredirect_uriへのリダイレクト(GET)になります。
アプリを起動したユーザーのログイン状態により以下の違いがあります
- 未ログインの場合は、ユーザーにログイン画面が表示される
- ログイン済みの場合は、ユーザーの入力が必要ない
上記の後に、入力パラメータで指定したredirect_uriにリダイレクトされます
ユーザーがログイン画面でログインしなかった場合は制御がアプリ側に戻りません
入力パラメータ
Section titled “入力パラメータ”| パラメータ | 値 | 省略 | 備考 |
|---|---|---|---|
client_id | ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブにあるクライアントID | 不可 | テスト環境で実施する場合は、テスト環境の値を指定する。販売する前には本番環境の値を指定する |
redirect_uri | ネクストエンジンへのログイン後、リダイレクトするuriを指定する | 可能(ネクストエンジンのアプリを作る->APIのRedirect URIになる) | ネクストエンジンのアプリを作る->APIのRedirect URIのホスト以外を指定することは出来ない |
出力パラメータ
Section titled “出力パラメータ”| パラメータ名 | 値 | 備考 |
|---|---|---|
| uid | アプリを起動したユーザーのuid | |
state | アプリを起動したユーザーのstate | stateには有効期限があります。有効期限が切れた場合は再度本APIを呼ぶ必要があります |
| 入力パラメータに渡したパラメータ | 上記パラメータ以外に、入力パラメータに渡したパラメータがそのまま返却されます |
エラーコード
Section titled “エラーコード”エンドポイント固有のエラーコードはありません。 共通エラーコードは メッセージコード一覧 を参照してください。
- 構造化スキーマビュー:
/openapi/operations/users_sign_in/(OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧:
/guides/param/message/(result/code/messageの意味)
同じカテゴリの他のエンドポイント (認証)
Section titled “同じカテゴリの他のエンドポイント (認証)”- アプリ利用企業一覧 —
POST /api_app/company - 企業情報取得 —
POST /api_v1_login_company/info - ログインユーザー情報取得 —
POST /api_v1_login_user/info - NEログインaccess_token取得 —
POST /api_neauth