DigitaLNXは統一ログインで業務を効率化するシステムです。SSO、API連携、会員制コンテンツ化を簡単に導入が可能です。多様なアプリケーションを統合し、操作を自動化します。利便性向上と収益化を支援し、柔軟なカスタマイズも可能。すべてのビジネスに新たな価値を提供します。

DigitaLNX API 連携ガイド

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

概要

DigitaLNX では、サイト利用者の認証・ユーザー情報の取得・メッセージ送信などを REST 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>

注意: 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

レスポンス

主な errorCode

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

URL: POST /api/member/authKaraage/

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

レスポンス

主な errorCode

会員: トークン検証

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

URL: POST /api/member/groupUserAuth/

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

レスポンス

主な errorCode

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

URL: POST /api/member/user/

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

レスポンス

会員: メッセージ送信

URL: POST /api/member/sendMessage/

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

レスポンス

サイト管理者向け JWT API

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

JWT: ログイン

URL: POST /api/jwt/loginConsole.php

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

レスポンス（成功時）

主な errorCode

JWT: トークン更新

URL: POST /api/jwt/refresh.php

成功時、新しい 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>（必須）

レスポンス例

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

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"
}

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

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

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 サポート窓口までご連絡ください。

API 接続ガイド

本書は first/api 配下の実装に基づく接続手順・パラメータ・レスポンス・エラー確認のまとめです。OpenAPI 定義はリポジトリ内にありません。

共通事項

環境変数（JWT / OIDC）

アプリ・DB

• PHP が first をドキュメントルート（またはそのサブパス）として解決できること
• first/dba/config.php 等による DB 接続が有効であること（会員系・JWT リフレッシュは DB を使用）

接続の流れ（概要）

1. 会員サイト向け: ドメイン/サイトコードでサイトを特定し、メールとパスワードで認証する（member/auth）。成功時は code に view 用 ID が入ります。
2. コンソール（管理）向け JWT: JSON で clientId / loginID / password を jwt/loginConsole.php に送り、accessToken と refreshToken を取得します。
3. トークン更新: refreshToken を jwt/refresh.php に POST してローテーションします。
4. 失効: refreshToken または Authorization: Bearer <accessToken> を jwt/revoke.php に渡します。
5. OIDC: oidc/start.php で authorizeUrl を取得 → ブラウザで IdP に遷移 → コールバック後に oidc/callback.php に code / state / stateToken を POST して JWT を取得します。

エンドポイント一覧とパラメータ定義表

会員: 認証（JSON）

URL: POST /api/member/auth/（旧: POST /api/auth/）

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

レスポンスフィールド

会員: からあげ等（フォームPOST）

URL: POST /api/member/authKaraage/（旧: POST /api/authKaraage/）

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

レスポンスフィールド

会員: メール取得

URL: POST /api/member/user/（旧: POST /api/user/）

レスポンスフィールド

会員: グループユーザートークン検証

URL: POST /api/member/groupUserAuth/（旧: POST /api/groupUserAuth/）

レスポンスフィールド

会員: メッセージ送信（JSON）

URL: POST /api/member/sendMessage/（旧: POST /api/sendMessage/）

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

レスポンスフィールド

JWT: コンソールログイン

URL: POST /api/jwt/loginConsole.php または POST /api/jwt/login.php
（実体: first/api/admin/jwt/loginConsole.php）

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

レスポンスフィールド

主な errorCode（実装より）

※ 認証失敗で result が error かつ errorCode が空のケースがあります（実装依存）。

JWT: リフレッシュ

URL: POST /api/jwt/refresh.php

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

レスポンスフィールド

errorCode（refresh）

JWT: 失効

URL: POST /api/jwt/revoke.php

リクエストヘッダー: Content-Type: application/json
任意ヘッダー: Authorization: Bearer <accessToken>

ルール: refreshToken と Bearer の少なくとも一方が必要。両方指定可能。

レスポンスフィールド

errorCode

JWT: パスワード変更

URL: POST /api/jwt/changePassword.php

リクエストヘッダー:

• Content-Type: application/json
• Authorization: Bearer <accessToken>（必須）

レスポンスフィールド

errorCode

成功時は当該ユーザーの全リフレッシュトークンが失効します。

OIDC: 開始

URL: POST /api/jwt/oidc/start.php

レスポンス（成功時）

errorCode: oidcDisabled, PostFieldError, oidcStartFailed

OIDC: コールバック（トークン交換）

URL: POST /api/jwt/oidc/callback.php

成功時は JWT ログインと同様に accessToken, refreshToken, expiresIn, tokenType, nextPage が返ります。

errorCode: oidcDisabled, PostFieldError, JWT_SECRET_UNSET, ユーザーマッピング失敗時は resolve_oidc_admin_user の結果、oidcCallbackFailed 等

管理: メールテスト

URL: GET /api/admin/test.php（旧: GET /api/test.php）

レスポンス: Content-Type: application/json — ユーザー情報の連想配列、または {"error":"not found"}。欠落時は HTTP 400 と {"error":"Specify mail address: ?mail="}。

レスポンス例

会員認証成功

{
  "action": "signin",
  "result": "success",
  "errorCode": "",
  "code": "<viewIDトークン>",
  "nextURL": ""
}

会員認証失敗（ドメイン不正）

{
  "action": "signin",
  "result": "error",
  "errorCode": "invalidDomain",
  "code": "",
  "nextURL": ""
}

JWT ログイン成功

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

JWT リフレッシュ成功

{
  "action": "jwtRefresh",
  "result": "success",
  "errorCode": "",
  "accessToken": "<新JWT>",
  "refreshToken": "<新opaque>",
  "expiresIn": 900,
  "tokenType": "Bearer"
}

JWT リフレッシュ失敗（期限切れ）

{
  "action": "jwtRefresh",
  "result": "error",
  "errorCode": "refresh_expired",
  "accessToken": "",
  "refreshToken": "",
  "expiresIn": 0,
  "tokenType": "Bearer"
}

会員メール取得成功

{
  "result": "OK",
  "errorCode": "",
  "mailAddress": "user@example.com"
}

OIDC start 成功（概念例）

{
  "action": "oidcStart",
  "result": "success",
  "errorCode": "",
  "state": "<state>",
  "stateToken": "<stateToken>",
  "authorizeUrl": "https://idp.example/authorize?...",
  "expiresIn": 300
}

エラー時の確認手順

1. HTTP ステータスだけ見ていないか

多くの API はエラーでも HTTP 200 のまま JSON で result: error を返します。クライアントは 本文の result / errorCode を必ず解釈してください。

2. 会員系で PostFieldError / siteCodeRequired 等

3. invalidDomain / invalidKey（member/auth）

• domain と code が DB 上のサイト定義と一致するか
• サイト側の登録・キー配布ミスがないか

4. CannotSignIn / 認証失敗

• メール・パスワードの誤り、未登録
• JWT ログインで needSignUp: メイン登録フローが必要

5. JWT_SECRET_UNSET

• サーバ環境に JWT_SECRET を設定し PHP から getenv('JWT_SECRET') で見えることを確認
• 設定変更後は PHP-FPM / Apache の再起動が必要な場合あり

6. JWT invalid_access_token / bearer_required

7. refresh で refresh_reuse / invalid_refresh

• 同一 refresh を二重送信していないか（ローテーション後は旧トークン無効）
• 失効・期限切れ後に古いトークンを使っていないか
• refresh_reuse はセキュリティ上、ファミリー単位で失効が進む実装です。全セッションを切りたい場合は revoke を検討

8. sendMessage で sendFailed

• AWS SES 等の送信設定・権限・レート制限
• noMailAddress: ユーザーにメールが未設定

9. OIDC で oidcDisabled / oidcStartFailed / oidcCallbackFailed

• 必須環境変数が揃っているか（OidcService の要件）
• OIDC_REDIRECT_URI が IdP 登録と完全一致するか
• state / stateToken の有効期限（start から 300 秒目安）内に callback しているか
• IdP の code が一度きりであること（再送不可）

10. 管理テスト API が 400

• GET で ?mail= を付けているか

参考実装パス