API Reference
English

HarmonyOs

集成要求

环境要求

说明
兼容版本API12及以上系统
支持架构arm64-v8a, x86_64

集成步骤

安装配置

安装说明

ohpm install @trustdecision/apisign

集成 SDK

在工程的 oh-package.json5 中设置三方包依赖,配置示例如下:

 "dependencies": {
   "@trustdecision/apisign": "1.0.0"
  }

接口签名

方法定义

public static sign(path: string): TDAPISignResult;

结构体定义

export class TDAPISignResult {
  // 签名结果
  signature: string
  // 签名状态码  
  code: number
  // 异常信息  
  message: string

  constructor(sign: string, code: number, msg: string) {
    this.signature = sign
    this.code = code
    this.message = msg
  }

最佳实践

待保护的API形如:https://cn.apitd.net/de/v1?name=jacky&age=12

import { TDAPISign } from "@trustdecision/apisign"

const signResult = TDAPISign.sign('de/v1')
if (signResult.code === 0) {
  // 获取签名并使用
  const signature: string = signResult.signature  
} else {
  // 获取错误信息和状态码
  const message: string = signResult.message
  const code: number = signResult.code
  // 继续业务逻辑,此处签名可以用空字符替代
}

状态检查

通过加签返回的结构体拿到的状态码为0,则加签成功

TDAPISignResult.code === 0

状态码

错误码错误信息处理方式
0成功/
2000path为空请设置path参数
22xx内部错误请联系同盾技术支持
5001调用so文件失败,可能是SDK依赖的so文件已经缺失请检查当前设备所使用的架构是否有配置到项目中