DigitaLNX API 連携ガイド

本書は、DigitaLNX と外部サイト・アプリケーションを連携するための公開向けドキュメントです。

概要

DigitaLNX では、サイト利用者の認証・ユーザー情報の取得・メッセージ送信などを REST API およびブラウザサインインで提供します。

項目内容
API ベース URLhttps://lnx.digital/api/
レスポンス形式JSON
Content-Type多くのエンドポイントは text/javascript; charset=utf-8 を返します
エラー表現HTTP 200 のまま JSON 内の result / errorCode で成功・失敗を判定してください

用語

用語説明
clientIdサイトまたはグループを識別する ID。API 呼び出しやサインイン URL に指定します
siteCodeサイト単位の clientId と同義で使われる場合があります
グループ1 つのサイト配下の区画（例: 別サービス・別アプリ）。グループごとに clientId が割り当てられます
コールバック URLブラウザサインイン成功後、利用者を戻す先 URL。DigitaLNX コンソールの「API連携設定」で登録します
userTokenサインイン成功後にコールバック URL へ付与される認証トークン
view コード（subID）サイト内でユーザーを識別するコード。トークン検証 API のレスポンスで取得します

連携パターン

パターン A: ブラウザサインイン + コールバック（推奨）

外部サイトから DigitaLNX のログイン画面へ誘導し、認証後に自サイトへ戻す方式です。

1. 利用者を DigitaLNX サインイン URL へリダイレクト
2. 利用者が ID / パスワードでログイン
3. 登録済みコールバック URL へリダイレクト（clientID と token が付与される）
4. 自サイト側で token を検証 API に送り、利用者を特定
5. 自サイトのセッションを開始

グループ clientId でサインインした場合、DigitaLNX 側の管理コンソール用セッションは作成されません。必ずコールバック先で userToken を受け取り、自サイト側でログイン状態を管理してください。

パターン B: API 直接認証

サーバーまたはクライアントアプリから、メールアドレスとパスワードを API に送信して認証する方式です。

  • JSON 認証: POST /api/member/auth/
  • フォーム POST 認証: POST /api/member/authKaraage/

ブラウザサインイン

サインイン URL

https://lnx.digital/auth/signin/?clientId=<clientId>
クエリ必須説明
clientIdはいサイトまたはグループの clientId
redirect任意ログイン後の遷移先（サイト種別により利用されない場合があります）

注意: URL パスは すべて小文字 の signin を使用してください。signIn（大文字 I）は Linux サーバー上では 404 になります。

サインイン成功後のリダイレクト（グループ clientId）

コールバック URL が登録されている場合:

https://<your-site>/path/to/callback?clientID=<clientId>&token=<userToken>

コールバック URL が未登録の場合、システム既定の URL が使われます。連携サイトでは 必ず DigitaLNX コンソールでコールバック URL を設定 してください。

コールバック URL の設定

  1. DigitaLNX 管理コンソールにログイン
  2. 対象サイトの サイト詳細 を開く
  3. API連携設定 で、該当 clientId のコールバック URL を登録

コールバック URL は http:// または https:// で始まる有効な URL である必要があります。

エンドポイント一覧

会員: 認証（JSON）

URL: POST /api/member/auth/

リクエストヘッダー: Content-Type: application/json

パラメータ必須型説明
domainはいstringサイト識別に使用するドメイン
codeはいstringサイト識別に使用するコード
emailはいstringログイン ID（メールアドレス）
passwordはいstringパスワード

レスポンス

フィールド説明
actionsignin
resultsuccess または error
errorCode失敗時の理由コード
code成功時: view 用 ID
nextURLサイト登録用コールバック URL（未設定時は空）

主な errorCode

errorCode意味
PostFieldError必須パラメータ不足
invalidDomainドメインが不正
invalidKeyサイトコードが不正
CannotSignIn認証失敗

会員: 認証（フォーム POST）

URL: POST /api/member/authKaraage/

リクエスト: application/x-www-form-urlencoded または multipart/form-data

パラメータ必須型説明
siteIDはいstringグループの clientId
loginIDはいstringログイン ID
passwordはいstringパスワード

レスポンス

フィールド説明
actionsingin
resultsuccess または error
errorCode失敗理由
code成功時: view 用 ID
nextURL未使用（空）

主な errorCode

errorCode意味
PostFieldError1〜6必須パラメータ不足
SiteCodeError3サイトコード不正
CannotSignIn認証失敗
NotRegist未登録

会員: トークン検証

ブラウザサインイン後に受け取った token を検証する API です。コールバック受け口での必須処理 です。

URL: POST /api/member/groupUserAuth/

リクエスト: application/x-www-form-urlencoded または multipart/form-data

パラメータ必須型説明
siteCodeはいstringclientId（コールバックの clientID と同じ値）
userTokenはいstringコールバックで受け取った token

レスポンス

フィールド説明
result成功時 OK、失敗時 error
errorCode失敗理由
subID成功時: ユーザーの view コード

主な errorCode

errorCode意味
siteCodeIsRequiredsiteCode 未指定
tokenRequireduserToken 未指定
inValidTokenトークンが無効または期限切れ
inValidCode-<siteID>_<siteCode>clientId がトークンと一致しない

会員: メールアドレス取得

URL: POST /api/member/user/

リクエスト: application/x-www-form-urlencoded または multipart/form-data

パラメータ必須型説明
siteCodeはいstringサイト clientId
userSubはいstringユーザーの view コード

レスポンス

フィールド説明
result成功時 OK、失敗時 error
errorCode失敗理由
mailAddress成功時: メールアドレス

会員: メッセージ送信

URL: POST /api/member/sendMessage/

リクエストヘッダー: Content-Type: application/json

パラメータ必須型説明
codeはいstringサイト clientId
subIDはいstringユーザーの view コード
subjectはいstring件名
messageはいstring本文

レスポンス

フィールド説明
actionsendMessage
resultsuccess または error
errorCode失敗理由

サイト管理者向け JWT API

DigitaLNX 管理コンソールや、サーバー間連携で JWT 認証を利用する場合に使用します。

JWT: ログイン

URL: POST /api/jwt/loginConsole.php

リクエストヘッダー: Content-Type: application/json

パラメータ必須型説明
clientIdはいstringサイト / グループの clientId
loginIDはいstringログイン ID
passwordはいstringパスワード
redirectURL任意stringログイン後の遷移先

レスポンス（成功時）

フィールド説明
resultsuccess
accessTokenJWT アクセストークン
refreshTokenリフレッシュトークン
expiresInアクセストークン有効秒数（既定 900 秒）
tokenTypeBearer
nextPage遷移先 URL

主な errorCode

errorCode意味
PostFieldError必須パラメータ不足
needSignUpアカウント未登録
invalidKeyclientId 不正

JWT: トークン更新

URL: POST /api/jwt/refresh.php

パラメータ必須型説明
refreshTokenはいstring前回取得したリフレッシュトークン

成功時、新しい accessToken と refreshToken が返ります。旧リフレッシュトークンは無効になります。

主な errorCode: refreshTokenRequired, invalid_refresh, refresh_reuse, refresh_expired

JWT: トークン失効

URL: POST /api/jwt/revoke.php

refreshToken または Authorization: Bearer <accessToken> の少なくとも一方が必要です。

JWT: パスワード変更

URL: POST /api/jwt/changePassword.php

ヘッダー: Authorization: Bearer <accessToken>（必須）

パラメータ必須型説明
currentPasswordはいstring現パスワード
newPasswordはいstring新パスワード

レスポンス例

ブラウザサインイン後のコールバック（自サイト側で受信）

GET https://example.com/auth/callback?clientID=6a4744635855bUTI1&token=abc123...

自サイトでは token を groupUserAuth API で検証してください。

トークン検証成功

{
  "result": "OK",
  "errorCode": "",
  "subID": "view-code-example"
}

会員認証成功（JSON API）

{
  "action": "signin",
  "result": "success",
  "errorCode": "",
  "code": "<viewID>",
  "nextURL": ""
}

JWT ログイン成功

{
  "action": "checkMailExists",
  "result": "success",
  "state": "",
  "errorCode": "",
  "nextPage": "https://lnx.digital/console/dashboard/",
  "accessToken": "<JWT>",
  "refreshToken": "<opaque>",
  "expiresIn": 900,
  "tokenType": "Bearer"
}

連携時のトラブルシューティング

サインイン後に再びログイン画面へ戻る

確認項目対応
コールバック URLDigitaLNX コンソールの API連携設定で正しい URL が登録されているか
clientId の種類グループ clientId の場合、DigitaLNX コンソール用セッションは作られません
トークン検証コールバック受け口で groupUserAuth を呼び出しているか
URL の大文字小文字サインイン URL は /auth/signin/（小文字）を使用する

API で PostFieldError が返る

  • JSON API には Content-Type: application/json と JSON 本文を送る
  • フォーム API には application/x-www-form-urlencoded を使う
  • パラメータ名の大文字小文字を表のとおりに指定する

inValidToken / inValidCode が返る

  • コールバックの clientID と siteCode が一致しているか
  • token を URL デコードしてから API に渡しているか
  • トークンの有効期限切れ（再ログインが必要）

JWT の invalid_access_token

  • Authorization: Bearer <JWT> 形式でヘッダーを送る
  • 期限切れの場合は refresh.php で更新する

サポート

API 連携設定（clientId・コールバック URL）は、DigitaLNX 管理コンソールの サイト詳細 → API連携設定 から確認・編集できます。

技術的なお問い合わせは、DigitaLNX サポート窓口までご連絡ください。

PAGE TOP