SDKのバックエンド

SDKでは、二つのバックエンドが利用できます。

APP バックエンド

APPバックエンドはSDKをポケットサインアプリ内で動作させる際に利用します。 APPバックエンドではSDKのすべての機能が利用できます。

以下のようにbackendにcreateAppBackendの返り値を渡すことで指定できます。

import { createSDKInstance, createAppBackend } from '@pocketsign/in-app-sdk'

const sdk = await createSDKInstance({
  serviceId,
  backend: createAppBackend()
})

ヒント

APPバックエンドをモック環境で使用するには、開発版アプリが必要です。

API バックエンド

APIバックエンドはSDKをパソコンのブラウザを含む通常のブラウザで動作させる際に利用します。 これを利用することでスマートフォン端末を利用せずに開発を行えます。 APIバックエンドはモック環境でのみ利用可能です。 ただし、APIバックエンドでは端末の機能を利用する一部の機能が利用できません。

以下のようにbackendにcreateApiBackendの返り値を渡すことで指定できます。

import { createSDKInstance, createApiBackend } from '@pocketsign/in-app-sdk'

const sdk = await createSDKInstance({
  serviceId,
  backend: createApiBackend({ accessToken: ACCESS_TOKEN })
})

ACCESS_TOKENは利用するデバッグユーザーのアクセストークンです。詳しくは、デバッグユーザーを参照してください。

注意

実際のプロジェクトでは、ソースコードにアクセストークンを直接記載せず、バンドラーの定数置き換え機能などを利用してください。 また、リリースビルドを生成する際にアクセストークンが含まれないように注意してください。

ヒント

ソースコードを直接書き換えずにバックエンドを切り替えるには、バンドラーの定数置き換え機能を利用します。 以下は、Viteのimport.meta.envを利用した例です。

import {
  createSDKInstance,
  createApiBackend,
  createAppBackend
} from '@pocketsign/in-app-sdk'

await createSDKInstance({
  serviceId,
  backend:
    import.meta.env.VITE_BACKEND === 'API'
      ? createApiBackend({
          accessToken: import.meta.env.VITE_DEV_ACCESS_TOKEN
        })
      : createAppBackend()
})

WebpackではDefinePluginが利用できます。