API

ApiFrontが提供するAPI一覧です。

ログインセッション情報取得API

GET /session

ログインセッションの詳細情報を返却します。
認証済ユーザ情報や、バックエンドへのアクセストークンやプロキシパス、その他コンフィグ情報の参照が可能です。起動パラメータによって返却される内容は異なります。
また、起動パラメータの authentication.generator に指定されたトークンジェネレータが存在する場合は、/session APIコール時にアクセストークンの再生成が行われます。この場合、authentication.transparentTokens の設定値によって以下のように挙動が異なる点に注意が必要です。

• authentication.transparentTokens : false [デフォルト]

ApiFrontでのトークンインジェクションは行わないため、SPA側からのAPIリクエストにtokenを埋め込む必要があります。したがってSPAの実装では、/session API のレスポンスのtoken情報を解析する必要があります。

• authentication.transparentTokens : true

ApiFrontでトークンインジェクションを行うため、SPA側からのAPIリクエストではtokenを全く意識する必要がありません。そのため、/session API のレスポンスにはtoken情報が含まれません。

Request (query)

Response (body)

サンプルレスポンス(SDKポータル認証連携の場合)

json
    {
        "id": "zqS7PBARlU9N55kYYCzA63VMMG9jYru6",
        "auth": {
            "account_id": "hogfuga@axis-dev.io",
            "account_role": "admin",
            "avatar": "https://lh3.googleusercontent.com/a-/XXXXXXX",
            "displayName": "hogfuga",
            "accessToken": "xxxx",
            "credentialExpires": "2021-06-22T06:24:43.943Z",
            "expires": null,
            "metadata": {
                "status": "Active"
            },
            "properties": {
                "emails": [
                    {
                        "value": "hogfuga@axis-dev.io",
                        "verified": true
                    }
                ],
                "roles": []
            },
            "provider": "qmonus",
            "strategy": "qmonus"
        },
        "backend": "/v1/",
        "configs": {
            "param1_enum" : ["dev-001" , "dev-002" ],
        },
        "params": {},
        "query": {},
        "sessions": [
            "zqS7PBARlU9N55kYYCzA63VMMG9jYru6"
        ]
    }

javascript
let baseURL = await http.get("/session").backend;
await http.get( `${baseURL}/hoge` )

ログアウトAPI

POST /logout , /signout

セッション情報を開放する（ログアウト）APIです。該当セッションの情報がセッションストアからクリアされます。ただし連携先の認証プロバイダーの情報からは削除されません
ちなみにmethodは、GETでも可能です。

認証連携API

GET /auth/[XXX]/callback

外部認証プロバイダ連携で必要なコールバックAPIです。
外部認証プロバイダのOAuthクライアント設定で指定するコールバックURLに含めてください。

※ XXXはコンフィグで指定した、authentication.name もしくは config.authentication.strategy になります。

ファイル生成API

パラメータで指定したデータを、ブラウザのファイルダウンロード機能でダウンロードさせる機能です。
※ ApiFrontの内部処理では、拡張子が pdf/png/jpeg/jpg のファイル生成に、puppeteer@1.20 を利用していますが、デフォルトではpuppeteerはバンドルされないため、この機能は利用できません。ご利用の際はサポートに問合せてください。

GET /echo (deprecated)

Request (query)

Sample Request

 curl https://api-front-xxxx.sdk-lab.qmonus.net/echo?template=preset&filename=test.pdf

POST /echo (deprecated)

Request (body)