初期化
初期化のタイミング
できるだけ早い段階でSDKを初期化してください — 通常、キャプチャフレームを含むページまたはコンポーネントが読み込まれるときです。キャプチャボタンのクリック時に初期化しない理由の詳細については、ベストプラクティスを参照してください。
認証情報の埋め込み
Onboardingチームから提供された認証情報を使用してUnicoConfigクラスを実装します:
import { UnicoConfig } from "unico-webframe"
const config = new UnicoConfig()
.setHostname("<YOUR_HOSTNAME>")
.setHostKey("<YOUR_HOST_KEY>");
ビルダーのインスタンス化
UnicoCheckBuilderの新しいインスタンスを作成します:
const unicoCameraBuilder = new UnicoCheckBuilder();
リソースパスの設定
追加ファイルのパスを指定します(プロジェクトに追加されている場合):
unicoCameraBuilder.setResourceDirectory("/resources");
AIモデルファイルのパスを指定します(スマートカメラモードでのみ必要):
unicoCameraBuilder.setModelsPath("https://yoursite.com/models");
3.18.0以降の自動フェッチ
バージョン3.18.0以降、SDKは追加リソースを自動的にフェッチできます — setResourceDirectoryを実装せず、CSP設定が正しく適用されていることを確認してください。
CSSリセットの設定(オプション)
デフォルトでは、SDKはコンポーネント全体の視覚的な一貫性を確保するためにCSSリセットを適用します。アプリケーションのCSSスタイルを保持するには、この機能を無効にします:
unicoCameraBuilder.disableCssReset();
環境の選択
サンドボックスと本番環境の選択は初期化時に行います。SDKEnvironmentTypes列挙型を使用します:
SDKEnvironmentTypes.PROD— 本番環境SDKEnvironmentTypes.UAT— ステージング環境
import {
UnicoCheckBuilder,
SDKEnvironmentTypes
} from "unico-webframe"
unicoCameraBuilder.setEnvironment(SDKEnvironmentTypes.UAT);
情報
設定されていない場合、Web SDKはデフォルトで本番環境を使用します。
利用可能な環境タイプの完全なリストについては、APIリファレンス > 初期化APIを参照してください。
ライフサイクル
バックエンドとのSDK認証には数秒かかります。ユーザーがキャプチャボタンをクリックしたときではなく、早めに初期化してください — そうしないと、クリックからカメラが開くまでの間にラグが生じます。