EloViewHome SDKでオフライントークンを使用する方法
対象者: Androidアプリケーション開発者およびシステムインテグレーター
記事の種類: 公開統合ガイド
認証を必要とするEloViewHome SDK APIを使用する際には、オフライントークンが必要です。オフライントークンは、特定のAndroidアプリケーションパッケージ名のために生成されます。
オフライントークンのリクエスト
まだオフライントークンをお持ちでない場合は、elo.support@zebra.com に連絡し、アプリケーションのAndroidパッケージ名を提供してください。
Eloサポートは、アプリケーションに関連付けられた資格情報を含む.propプロパティファイルを提供します。このプロパティファイルには、アプリケーションパッケージ名とJWTオフライントークンが含まれています。
package_name=com.example.application
jwt=<offline_token>
⚠️ 重要な帰属警告
オフライントークンは、指定されたAndroidアプリケーションパッケージ名に厳密に結びついています。Eloサポートに提供されたパッケージ名が本番用アプリケーションパッケージ名と一致していることを確認してください。一致しない場合、トークンの検証は即座に失敗します。
EloViewHome SDKに含まれる例
EloViewHome SDKには、EloViewHomeテストアプリと完全なテストアプリのソースコードが含まれています。このソースプロジェクトは、プロパティファイルからオフライントークンを読み込み、EloViewHome SDKを通じて検証する例を提供します。
テストアプリのソースでは、プロパティファイルはアプリケーションのassetsディレクトリに保存されています。アプリケーションはプロパティファイルをロードし、jwt値を取得し、トークンをverifyEloToken() APIに渡します。
val credentials = Properties()
credentials.load(
applicationContext.assets.open("your_application_jwt.prop")
)
val accessToken = credentials.getProperty("jwt")
AccountManager.instance.verifyEloToken(
applicationContext,
accessToken,
accessTokenHandler
)
トークンの検証
オフライントークンは、EloViewHome SDKのAccountManager.verifyEloToken() APIを使用して検証されます。
SDKは、提供されたハンドラーを通じてトークン検証結果を返します。成功した検証はTOKEN_VERIFY_SUCCESSを返します。トークンが検証できない場合、SDKはTOKEN_VERIFY_FAILを返します。
💡 一般的なトークン検証の落とし穴 (TOKEN_VERIFY_FAIL):
- トークンペイロードが破損しているか、不正な形式である。
- トークンの有効期限が切れている(非永久的に設定されている場合)。
- コンパイルされたアプリケーションのパッケージ名が証明書のメタデータと正確に一致しない。
含まれているテストアプリを参照として使用する
EloViewHome SDKに含まれるテストアプリは、トークンの検証プロセスを示しています。テストアプリでは、次の場所に移動します:
アカウントマネージャAPI > 資格情報を含むファイルをロードして検証 > トークンをロードして検証
含まれているテストアプリは、デバイスストレージからプロパティファイルを選択するのではなく、アプリケーションのassetsから直接サンプルプロパティファイルをロードします。開発者は含まれているテストアプリのソースコードを確認し、オフライントークン認証を独自のアプリケーションに統合する際の参照としてアカウントマネージャの実装を使用するべきです。
追加情報
EloViewHome SDKパッケージには、次のものが含まれています:
- EloViewHome SDKライブラリ
- インストール可能なEloViewHomeテストアプリ
- 完全なテストアプリのソースプロジェクト
- EloViewHome SDK APIドキュメント
追加の実装詳細については、テストアプリのソースとSDKに含まれるcom.eloview.sdk.accountManager.AccountManager APIドキュメントを参照してください。
関連記事
Please report any broken links by emailing elo.support@zebra.com and include a link to the knowledge article