HarmonyOS client integration

Request a certification scheme key

API calls require a scheme code and a key. To obtain them, go to the Phone Number Verification Service console and create a certification scheme. You will need to provide your app name, package name, package signature, and AppId.

bundleManager.getBundleInfoForSelf(bundleManager.BundleFlag.GET_BUNDLE_INFO_WITH_SIGNATURE_INFO).then((bundleInfo) => {
  const packageName = bundleInfo.name
  console.log("numberauth:pagname:" + packageName)
  const sign = bundleInfo.signatureInfo.fingerprint
  console.log("numberauth:sign:" + sign)
  const appIdentifier = bundleInfo.signatureInfo.appIdentifier
  console.log("numberauth:appid:" + appIdentifier)
})

Get the SDK

Log in to the Phone Number Verification Service console. On the overview page, in the API & SDK section on the right, click Download Now. On the API & SDK page, select Phone Number Verification Service for HarmonyOS.

Import the project

1. Create or open your project in DevEco Studio.

2. Extract the downloaded package and copy the .har file to the libs directory in your project.

   

3. Add the SDK dependency to the oh_package.json5 file in your module:

   Note: This is the oh_package.json5 file in the module, not the one in the project's root directory. For example, refer to the demo project in the package.

   "dependencies": {
       "numberauth_standard": "file:libs/auth_number_product-2.0.1-log-online-standard-release.har"
     }

   

Configure permissions

Edit the module.json5 file to configure the required permissions for the SDK:

    "requestPermissions": [
      {
        "name": "ohos.permission.INTERNET"
      },
      {
        "name": "ohos.permission.GET_NETWORK_INFO"
      },
      {
        "name": "ohos.permission.SET_NETWORK_INFO"
      }
    ]

Interaction flow

For the complete interaction flow, see mobile number verification.

SDK API reference

public static getInstance(context: Context, listener: TokenResultListener): PhoneNumberAuthHelper;

class TokenListener implements TokenResultListener {
    private page: Index

    constructor(page: Index) {
        this.page = page;
    }

    onSuccess(msg: string): void {
        console.log("auth:onSuccess:" + msg)
        const result: object = JSON.parse(msg)
        const code = result['_code'] + ''
        const token = result['_token'] + ''
        if (code === "600000") {
            this.page.quitLoginPage()
        }
    }

    onFailure(ret: string): void {
        console.log("auth:onFailure:" + ret)
        this.page.updateAuth()
    }
}

let listener = new TokenListener(this)
this.helper = PhoneNumberAuthHelper.getInstance(getContext(this), listener)

public setAuthSDKInfo(secretInfo: string): void

public clearAuthListener():void

// totalTime: The timeout in milliseconds (ms).
public getVerifyToken(totalTime: number):  Promise<void>;;

    this.helper.getVerifyToken(5000)

 class TokenListener implements TokenResultListener{
     private page:Index
      constructor(page: Index) {
        this.page = page;
      }
      onSuccess(msg: string): void {
        console.log("auth:onSuccess:"+msg)
        const result:object=JSON.parse(msg)
        const code=result['_code']+''
        const token=result['_token']+''
        if(code=="600000"){
          this.page.quitLoginPage()
        }
      }
      onFailure(ret: string): void {
        console.log("auth:onFailure:"+ret)
        this.page.updateAuth()
      }
    }

public accelerateVerify(overdueTimeMills: number, listener: PreLoginResultListener): void

public setAuthListener(listener: TokenResultListener): void

public checkEnvAvailable(type: number): void

After adding the SDK dependency, click Sync in the upper-right corner of the IDE to import it.

If the import fails, follow these steps:

1. Delete the oh_modules directory from the module and the project's root directory.

2. Then, run ohpm install in the Terminal at the bottom of DevEco Studio to re-import.

   ohpm install
   (node:11186) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
   (Use `node --trace-deprecation ...` to show where the warning was created)
   ohm INFO: remove useless folder succeed: "/Users/cmw01044812/Desktop/HmProject/NumberAuthDemo/oh_modules/.tmp"
   install completed in 0s 300ms
   ohpm install
   (node:11667) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
   (Use `node --trace-deprecation ...` to show where the warning was created)
   ohm INFO: remove useless folder succeed: "/Users/cmw01044812/Desktop/HmProject/NumberAuthDemo/oh_modules/.tmp"
   install completed in 0s 297ms
   ohpm install
   (node:12153) [DEP0040] DeprecationWarning: The `punycode` module is deprecated. Please use a userland alternative instead.
   (Use `node --trace-deprecation ...` to show where the warning was created)
   install completed in 0s 217ms