# 認証 — ネクストエンジン API > 認証 カテゴリの API endpoint (5 件) を集約したファイル。 > インデックス: https://developer.next-engine.com/llms.txt | 全文: https://developer.next-engine.com/llms-full.txt --- # NEログインaccess_token取得 URL: https://developer.next-engine.com/api/api_v1_neauth/ Method: POST API Endpoint: https://api.next-engine.org/api_neauth Tag: 認証 Required parameters: access_token, uid, state, client_id, client_secret Optional parameters: refresh_token, wait_flag, fields, offset, limit --- # NEログインuid・state取得 URL: https://developer.next-engine.com/api/api_v1_sign_in/ Method: POST API Endpoint: https://api.next-engine.org/users/sign_in Tag: 認証 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit, client_id, redirect_uri --- # アプリ利用企業一覧 URL: https://developer.next-engine.com/api/api_app/company/ Method: POST API Endpoint: https://api.next-engine.org/api_app/company Tag: 認証 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit, client_id, client_secret ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_app/company` ## リファレンス内容 ### アプリの利用企業一覧について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 本APIはアプリを利用可能な企業(※)のメイン機能企業ID(company_id)の一覧を返却します ※：無料期間中・契約中・解約予定の企業を利用可能な企業として返却します。解約が終了した企業は結果に返却しません 　　一度利用不可能になった企業が再契約した場合、再度利用可能な企業になります ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `client_id` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「詳細」または「編集」 -> 「API」タブにあるクライアントID | 不可(SDKの場合不要) | テスト環境で実施する場合は、テスト環境の値を指定する。販売する前には本番環境の値を指定する | | `client_secret` | ネクストエンジンの「アプリを作る」 -> 該当アプリの「詳細」または「編集」 -> 「API」タブにあるクライアントシークレット | 不可 | client_idと同じ | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) 例）"data": [{ "company_id": "xxxxxxxxx", "company_ne_id": "yyyyyyyy" }] | フィールドは企業のメイン機能企業ID（company_id）とネクストエンジン企業ID（company_ne_id）です。アプリ種別が「ログインのみアプリ」の場合は、メイン機能企業ID（company_id）がnullとなりますのでご注意ください。 また、企業情報の取得は、各企業がアプリを起動した際に企業情報取得にて保持して下さい | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'client_id=xxxxxxxxx&client_secret=xxxxxxxxxxxxx' https://api.next-engine.org/api_app/company ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "company_id": "xxxxxxxxxxxxxx" } ] } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/openapi/operations/api_app_company/`](/openapi/operations/api_app_company/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (認証) - [企業情報取得](/api/api_v1_login_company/info/) — `POST /api_v1_login_company/info` - [ログインユーザー情報取得](/api/api_v1_login_user/info/) — `POST /api_v1_login_user/info` - [NEログインaccess_token取得](/api/api_neauth/) — `POST /api_neauth` - [NEログインuid・state取得](/api/users/sign_in/) — `POST /users/sign_in` --- # ログインユーザー情報取得 URL: https://developer.next-engine.com/api/api_v1_login_user/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_login_user/info Tag: 認証 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_login_user/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `access_token` | access_token取得により取得した値 | 必須(SDKの場合不要) | | | `refresh_token` | access_token取得により取得した値 | 可能(SDKの場合不要) | 【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります（成功時以外の出力パラメータ参照) | | `wait_flag` | 1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却 | 可能(省略時は1以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### ログインユーザー | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | メイン機能担当者ID | `pic_id` | 数値型 | アプリを起動したユーザーの「メイン機能・ユーザー単位」で一意になるID | | 担当者名 | `pic_name` | 文字列型 | | | 担当者カナ | `pic_kana` | 文字列型 | | | 部署名 | `pic_post_name` | 文字列型 | | | 社会保険区分 | `pic_social_insurance_id` | 文字列型 | | | 社会保険名 | `pic_social_insurance_name` | 文字列型 | | | 誕生日 | `pic_birth_date` | 日時型 | | | 郵便番号 | `pic_zip_code` | 文字列型 | | | 住所1 | `pic_address1` | 文字列型 | | | 住所2 | `pic_address2` | 文字列型 | | | 携帯番号 | `pic_mobile` | 文字列型 | | | 電話番号 | `pic_phone` | 文字列型 | | | メールアドレス | `pic_mail_address` | 文字列型 | | | 入社日 | `pic_entering_company_date` | 日時型 | | | 退職日 | `pic_retirement_date` | 日時型 | | | 担当店舗コードリスト | `pic_charge_shop_id_list` | 文字列型 | | | テンプレートフラグ | `pic_template_flag` | 文字列型 | | | スキンカラー | `pic_skin_color` | 文字列型 | | | 言語コード | `pic_language_code` | 文字列型 | | | uid | uid | 文字列型 | アプリを起動したユーザーの「購入アプリ・ユーザー単位」で一意になるID | | ネクストエンジン担当者ID | `pic_ne_id` | 文字列型 | アプリを起動したユーザーの「ユーザー単位」で一意になるID | | 削除フラグ | `pic_deleted_flag` | 文字列型 | | | 作成日 | `pic_creation_date` | 日時型 | | | 最終更新日 | `pic_last_modified_date` | 日時型 | | | 作成担当者ID | `pic_creator_id` | 数値型 | | | 作成担当者名 | `pic_creator_name` | 文字列型 | | | 最終更新者ID | `pic_last_modified_by_id` | 数値型 | | | 最終更新者名 | `pic_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" \ -d 'access_token=xxxxxxxxxxxxxx&refresh_token=xxxxxxxxxxxxxx&wait_flag=1' \ "https://api.next-engine.org/api_v1_login_user/info" ``` レスポンス ```json { "result":"success", "count":"1", "data":[ { "pic_id":"10002", "pic_name":"xxxxxxxxxxxxxx", "pic_kana":"xxxxxxxxxxxxxx", "pic_post_name":"xxxxxxxxxxxxxx", "pic_social_insurance_id":null, "pic_social_insurance_name":null, "pic_birth_date":"0000-00-00", "pic_zip_code":"", "pic_address1":"", "pic_address2":"", "pic_mobile":"", "pic_phone":"", "pic_mail_address":"xxxxx@xxxx.xxx", "pic_entering_company_date":"0000-00-00", "pic_retirement_date":"0000-00-00", "pic_charge_shop_id_list":null, "pic_template_flag":"1", "pic_skin_color":null, "pic_language_code":null, "pic_creation_date":"2017-01-11 18:24:04", "pic_last_modified_date":"2017-03-07 15:10:24", "pic_creator_id":"9999", "pic_creator_name":"xxxxxxxxxx", "pic_last_modified_by_id":"10002", "pic_last_modified_by_name":"xxxxxxxxxx", "uid":"xxxxxxxxxxxxxx", "pic_ne_id":xxxxxxxxx" } ], "access_token":"xxxxxxxxxx", "access_token_end_date":"2017-04-13 18:24:53", "refresh_token":"xxxxxxxxxx", "refresh_token_end_date":"2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/openapi/operations/api_v1_login_user_info/`](/openapi/operations/api_v1_login_user_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) ### 同じカテゴリの他のエンドポイント (認証) - [アプリ利用企業一覧](/api/api_app/company/) — `POST /api_app/company` - [企業情報取得](/api/api_v1_login_company/info/) — `POST /api_v1_login_company/info` - [NEログインaccess_token取得](/api/api_neauth/) — `POST /api_neauth` - [NEログインuid・state取得](/api/users/sign_in/) — `POST /users/sign_in` --- # 企業情報取得 URL: https://developer.next-engine.com/api/api_v1_login_company/info/ Method: POST API Endpoint: https://api.next-engine.org/api_v1_login_company/info Tag: 認証 Required parameters: access_token Optional parameters: refresh_token, wait_flag, fields, offset, limit ## リクエストURL ホスト `https://api.next-engine.org` エンドポイント `/api_v1_login_company/info` ## リファレンス内容 ### 情報取得について 入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります 情報取得と検索APIの違いは、以下の通りです - 情報取得は、対象データを全て取得します（検索条件などの指定が不可能） - 情報取得は、全フィールドを取得します（取得対象フィールドの指定が不可能） ### 入力パラメータ | パラメータ | 値 | 省略 | 備考 | | --- | --- | --- | --- | | `access_token` | access_token取得により取得した値 | 必須(SDKの場合不要) | | | `refresh_token` | access_token取得により取得した値 | 可能(SDKの場合不要) | 【指定してaccess_tokenの有効期限が切れた場合】 正常に出力パラメータが設定されaccess_tokenとrefresh_tokenが新しい値に更新されます 【省略してaccess_tokenの有効期限が切れた場合】 出力パラメータ「result」の値がredirectになります（成功時以外の出力パラメータ参照) | | `wait_flag` | 1:メイン機能過負荷でも可能な限りエラーにせず実行1以外:メイン機能過負荷の場合、003002のエラーを返却 | 可能(省略時は1以外とする) | 詳細はパラメータ共通事項「待機フラグについて」を参照して下さい | ### 出力パラメータ | パラメータ名 | 値 | 備考 | | --- | --- | --- | | `result` | `success` | success以外の場合の出力パラメータは成功時以外の出力パラメータ参照 | | `access_token` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_token | 有効なrefresh_tokenを指定してaccess_tokenの有効期限がきれた場合、新たに発行(この時点から1日有効)されたaccess_tokenになります | | `refresh_token` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_token | access_tokenが新しく発行された場合、新たに発行(この時点から3日有効)されたrefresh_tokenになります | | `access_token_end_date` | 入力パラメータで指定したaccess_token／新たに発行されたaccess_tokenの有効期限日時 | | | `refresh_token_end_date` | 入力パラメータで指定したrefresh_token／新たに発行されたrefresh_tokenの有効期限日時 | | | `count` | 検索結果の件数 | | | `data` | 検索結果の連想配列(JSONのオブジェクト型) | 検索対象の全フィールドを返却します | ### 企業 | 項目名 | フィールド名 | データ型 | 備考 | | --- | --- | --- | --- | | 企業名 | `company_name` | 文字列型 | | | 企業名カナ | `company_kana` | 文字列型 | | | 郵便番号 | `company_zip_code` | 文字列型 | | | 住所1 | `company_address1` | 文字列型 | | | 住所2 | `company_address2` | 文字列型 | | | 部署名 | `company_post_name` | 文字列型 | | | 担当者名 | `company_pic_name` | 文字列型 | | | メールアドレス | `company_mail_address` | 文字列型 | | | 電話番号 | `company_phone` | 文字列型 | | | FAX | `company_fax` | 文字列型 | | | 企業URL | `company_url` | 文字列型 | | | 締日 | `company_closing_day` | 文字列型 | | | 最終締日 | `company_last_closing_date` | 日時型 | | | 端数処理桁数 | `company_fraction_number_digit` | 数値型 | | | 端数処理区分 | `company_fraction_id` | 文字列型 | | | 端数処理名 | `company_fraction_name` | 文字列型 | | | 税抜き・税込み区分 | `company_tax_id` | 文字列型 | | | 税抜き・税込み名 | `company_tax_name` | 文字列型 | | | 一時利用停止フラグ | `company_temporarily_suspend_flag` | 文字列型 | | | 有効日 | `company_available_date` | 日時型 | | | 無効日 | `company_unavailable_date` | 日時型 | | | 通知先メールアドレス | `company_notice_mail_address` | 文字列型 | | | 仕入れタイプ | `company_buying_type` | 文字列型 | | | バッチタイプ | `company_batch_type` | 文字列型 | | | クーポンコード | `company_coupon_code` | 文字列型 | | | 企業区分 | `company_type_id` | 文字列型 | | | IPアドレス | `company_ip_address` | 文字列型 | | | 明細ソート | `company_row_order` | 数値型 | | | メイン機能企業ID | `company_id` | 文字列型 | アプリを起動した企業の「メイン機能単位」で一意になるID。１つの企業が複数のメイン機能を所有することがあります。 | | ネクストエンジン企業ID | `company_ne_id` | 文字列型 | アプリを起動した企業の一意になるID。 | | メイン機能ホスト | `company_host` | 文字列型 | | | 現在の税率 | `company_now_tax_percent` | 数値型 | 10%の場合、10 | | 値引きの優先適用先 | `company_primary_tax_rate_for_discount` | 数値型 | NULL:按分10:10%8:8%0:0% | | 適格請求書発行事業者の登録番号 | `company_invoice_registration_number` | 文字列型 | | | ヒット商品お知らせ期間 | `company_hit_syohin_alert_hour` | 数値型 | 0の場合、お知らせしない | | ヒット商品お知らせ個数 | `company_hit_syohin_alert_quantity` | 数値型 | 全商品に対して有効です。商品マスタに商品ごとの設定がある場合は、そちらが優先されます。 | | 削除フラグ | `company_deleted_flag` | 文字列型 | | | 作成日 | `company_creation_date` | 日時型 | | | 最終更新日 | `company_last_modified_date` | 日時型 | | | 作成担当者ID | `company_creator_id` | 数値型 | | | 作成担当者名 | `company_creator_name` | 文字列型 | | | 最終更新者ID | `company_last_modified_by_id` | 数値型 | | | 最終更新者名 | `company_last_modified_by_name` | 文字列型 | | サンプル ### サンプル リクエスト ```bash curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'uid=xxxxxxxxxxxxxx&state=xxxxxxxxxxxxxx' "https://api.next-engine.org/api_v1_login_company/info" ``` レスポンス ```json { "result": "success", "count": "1", "data": [ { "company_name": "xxxxxxxx", "company_kana": "xxxxxxxx", "company_zip_code": "1500013", "company_address1": "xxxxxxxx", "company_address2": "", "company_post_name": null, "company_pic_name": "xxxxxxxx", "company_mail_address": "xxxx@xxxx.xxx", "company_phone": "0361231231", "company_fax": "", "company_url": "", "company_closing_day": null, "company_last_closing_date": null, "company_fraction_number_digit": "0", "company_fraction_id": "1", "company_fraction_name": "xxxxxxxx", "company_tax_id": "0", "company_tax_name": "xxxxxxxx", "company_temporarily_suspend_flag": "", "company_available_date": "2016-12-19 14:02:20", "company_unavailable_date": "0000-00-00 00:00:00", "company_notice_mail_address": null, "company_buying_type": "0", "company_batch_type": "U", "company_coupon_code": "", "company_type_id": "", "company_ip_address": null, "company_row_order": "0", "company_now_tax_percent": "8", "company_hit_syohin_alert_hour": "0", "company_hit_syohin_alert_quantity": "0", "company_primary_tax_rate_for_discount": "10", "company_invoice_registration_number": "T1234567890123", "company_creation_date": "2017-03-16 19:16:56", "company_last_modified_date": "2017-03-16 19:16:56", "company_creator_id": "0", "company_creator_name": "System", "company_last_modified_by_id": "0", "company_last_modified_by_name": "System", "company_last_modified_null_safe_date": "2017-03-16 19:16:56", "company_last_modified_by_null_safe_id": "0", "company_last_modified_by_null_safe_name": "System", "company_id": "xxxxxxxx", "company_ne_id": "xxxxxxxx", "company_host": "xxxxxxxx", "company_app_header": "xxxxxxxx" } ], "access_token": "xxxxxxxx", "access_token_end_date": "2017-04-13 18:24:53", "refresh_token": "xxxxxxxx", "refresh_token_end_date": "2017-04-15 18:24:53" } ``` ## エラー ### エラーコード エンドポイント固有のエラーコードはありません。 共通エラーコードは [メッセージコード一覧](/guides/param/message/) を参照してください。 ## 関連リンク - 構造化スキーマビュー: [`/openapi/operations/api_v1_login_company_info/`](/openapi/operations/api_v1_login_company_info/) (OpenAPI 3.1 のインタラクティブ仕様) - エラーコード一覧: [`/guides/param/message/`](/guides/param/message/) (`result`/`code`/`message` の意味) - フィールド一覧: [`/guides/fields/login_company/`](/guides/fields/login_company/) (このエンドポイントが扱うデータ項目) ### 同じカテゴリの他のエンドポイント (認証) - [アプリ利用企業一覧](/api/api_app/company/) — `POST /api_app/company` - [ログインユーザー情報取得](/api/api_v1_login_user/info/) — `POST /api_v1_login_user/info` - [NEログインaccess_token取得](/api/api_neauth/) — `POST /api_neauth` - [NEログインuid・state取得](/api/users/sign_in/) — `POST /users/sign_in`