In-App SDK

PocketSign Link v2 では、認証・認可は OIDC フロー、リソースの読み書きは Link v2 API で行います。 In-App SDK は、ポケットサインアプリのミニアプリブラウザ上で動作する際のユーティリティ機能を提供します。

セットアップ

パッケージレジストリの設定

.npmrc ファイルをプロジェクトのルートディレクトリに作成し、以下の内容を追加してください。

@pocketsign:registry=https://repo.platform.p8n.app
//repo.platform.p8n.app/:_auth=<YOUR_BASIC_AUTH_STRING>

<YOUR_BASIC_AUTH_STRING> の部分は、以下のコマンドによって生成される値を入力してください。

echo -n "token-user:<YOUR_SDK_TOKEN>" | base64

<YOUR_SDK_TOKEN> の部分は、SDK 取得用トークンを入力してください。SDK 取得用トークンの取得方法は SDK 取得用トークンの作成を参照してください。

注意

実際のプロジェクトでは、.npmrc に SDK トークンを直接記載しないでください。また、VCS にトークンが記録されないように注意してください。

インストール

npm install @pocketsign/in-app-sdk

ポケットサインアプリ内判定

isInApp を使って、現在のページがポケットサインアプリのミニアプリブラウザ内で動作しているかどうかを判定できます。ポケットサインアプリ固有の機能（closeWindow など）を利用する場合に使用します。

import { isInApp } from "@pocketsign/in-app-sdk";

if (isInApp()) {
  // ポケットサインアプリ内で動作中
  // closeWindow 等のネイティブ機能が使える
} else {
  // ブラウザで動作中
  // ネイティブ機能は使えない
}

KLON 対応判定

isKLONSupported を使って、現在のポケットサインアプリが KLON（PocketSign Link v2）に対応しているかどうかを判定できます。 KLON 非対応の旧バージョンのアプリで開かれた場合にアップデートを促す用途で使用します。

import {
  isKLONSupported,
  requestAppUpdate,
} from "@pocketsign/in-app-sdk";

if (!isKLONSupported()) {
  // 旧ポケットサインアプリ: アップデートを要求
  requestAppUpdate();
  return;
}

// KLON ベースのフローへ

詳細は In-App SDK からの移行を参照してください。

ウィンドウ操作

closeWindow を使って、ミニアプリブラウザのウィンドウを閉じることができます。

import { closeWindow } from "@pocketsign/in-app-sdk";

closeWindow();

セットアップ​

パッケージレジストリの設定​

インストール​

ポケットサインアプリ内判定​

KLON 対応判定​

ウィンドウ操作​

関連ページ​