TossAuth.sign

函数式 API appsInTossSignTossCert也可以这样使用同样的功能。

功能说明

使用 Toss 证书进行签名。 txId是使用 Toss 证书进行身份验证、简易认证、电子签名时使用的 Transaction Id。

Toss App Android/iOS 5.233.0 可在以上版本使用。若在不支持的版本中调用则 UNSUPPORTED_APP_VERSION 会发生错误。

类型

TossAuth.sign(params: AppsInTossSignTossCertParams): Promise<void>;

Params

type AppsInTossSignTossCertParams = {
  txId: string;
};

Response

无

错误代码

错误代码是 catch 到的错误的 error.code 值。

代码	说明
UNSUPPORTED_APP_VERSION	如果当前运行的 Toss App 版本不支持此功能，调用后会立即发生。 TossAuth.sign.isSupported()可通过它提前确认，发生时 error.message请向用户显示（更新提示文案）。

示例代码

import { TossAuth } from "@apps-in-toss/web-framework";

const button = document.querySelector("#sign-button");

button.addEventListener("click", async () => {
  try {
    await TossAuth.sign({ txId: "f2e1a6df..." });
  } catch (error) {
    console.error(error);
  }
});