access_token取得について

本APIはSDKを用いず、アプリから直接HTTP(S)通信を用いて認証してAPIを使う方向けの資料です

入力パラメータはPOST、出力パラメータはレスポンス(レスポンスボディにJSON)になります

access_token・refresh_tokenの取扱注意事項

アクセストークン(及びリフレッシュトークン)は、ユーザーのメイン機能の情報にアクセス出来る重要な情報です

アクセストークン(及びリフレッシュトークン)の漏洩は、ユーザーのメイン機能の情報の漏洩に繋がる可能性があります

漏洩のリスクを下げる為にも、アプリケーションサーバー(及びアプリのDBサーバー)とAPIサーバーとの通信以外には使わないで下さい

(ユーザーにアプリケーションサーバーからアクセストークン・リフレッシュトークンを返却する事も漏洩のリスクを高めてしまいます)

入力パラメータ

                      

パラメータ 省略 備考
uid uid・state取得により取得した値 必須
state uid・state取得により取得した値 必須
client_id ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブにあるクライアントID 必須
client_secret ネクストエンジンの「アプリを作る」 -> 該当アプリの「編集」 -> 「API」タブにあるクライアントシークレット 必須

出力パラメータ

パラメータ名 備考
result success success以外の場合の出力パラメータは成功時以外の出力パラメータ参照
access_token メイン機能のデータにアクセスする為のトークン access_tokenには有効期限(1日)があります。有効期限が切れないようにする為にも、各APIを実行する際にrefresh_tokenも指定することを推奨します
refresh_token access_tokenの有効期限が切れた際に、access_tokenを再発行する為のトークン refresh_tokenには有効期限(3日)があります。有効期限が切れた場合はuid・state取得を呼ぶ必要があります
company_ne_id アプリを購入した企業のネクストエンジンで一意になるID
company_name アプリを購入した企業の企業名
company_kana アプリを購入した企業の企業名かな
uid アプリを起動したユーザーの「購入アプリとユーザー単位」で一意になるID 同じユーザーでも複数同じアプリを利用した場合は、uidが別になります。同一人物か判定する場合はpic_ne_idを利用します
pic_ne_id アプリを起動したユーザーの「ユーザー単位」で一意になるID メイン機能のpic_idとは別。1ユーザーが複数のメイン機能を使うケースがある
pic_name アプリを起動したユーザーの氏名
pic_kana アプリを起動したユーザーの氏名かな
pic_mail_address アプリを起動したユーザーのメールアドレス