認証 Auth

Auth API は、ユーザー認証、ログイン、生体認証など、セキュリティに関する機能を提供します。

オンラインで試す

getUserProfilerequestSSOLogin

生体認証requestAuthorizationToken

結果は下に表示されます

Auth API デモ

ユーザープロフィール、SSO、生体認証、認可トークンのモック結果を取得します

Vue

<script setup>
import { ref } from 'vue'
import woo from 'mini-sdk'

const profile = ref(null)

async function login() {
  woo.showLoading('登录中...')
  try {
    const { code } = await woo.requestSSOLogin()
    const res = await woo.request.post('/api/auth/login', { code })
    await woo.setStorage({ key: 'token', data: res.data.token })
    profile.value = await woo.getUserProfile()
    woo.showToast({ title: '登录成功', icon: 'success' })
  } finally {
    woo.hideLoading()
  }
}
</script>

<template>
  <div v-if="profile">{{ profile.nickname }}</div>
  <button v-else @click="login">SSO 登录</button>
</template>

React

import { useState } from 'react'
import woo from 'mini-sdk'

function LoginPage() {
  const [profile, setProfile] = useState(null)

  async function login() {
    woo.showLoading('登录中...')
    try {
      const { code } = await woo.requestSSOLogin()
      const res = await woo.request.post('/api/auth/login', { code })
      await woo.setStorage({ key: 'token', data: res.data.token })
      setProfile(await woo.getUserProfile())
      woo.showToast({ title: '登录成功', icon: 'success' })
    } finally {
      woo.hideLoading()
    }
  }

  return (
    <>
      {profile ? <div>{profile.nickname}</div> : <button onClick={login}>SSO 登录</button>}
    </>
  )
}

インポート

import woo from 'mini-sdk'
// 或
import { auth } from 'mini-sdk'

API リファレンス

requestSSOLogin

SSO（シングルサインオン）ログインを開始します。

const result = await woo.requestSSOLogin()

戻り値 SSOLoginResult：

フィールド	型	説明
code	string	認可コード
state	string	ステートトークン

ACK の仕組み

SSO ログインは対話的な操作です。Host がリクエストを受け取ると、まず ack を送信し、SDK が自動的にタイムアウトを 5 分に延長し、ユーザー操作の途中でタイムアウトしないようにします。

---

requestLinkedLogin

連携ログイン（IdP 連携）を開始します。

const result = await woo.requestLinkedLogin({
  provider: 'wechat',
  scope: 'basic',
})

---

submitAccountLink

アカウントの連携登録を送信します。

await woo.submitAccountLink({
  provider: 'phone',
  credential: '+86138xxxx1234',
  verificationCode: '123456',
})

---

unlinkAccount

アカウントの連携を解除します。

await woo.unlinkAccount({ provider: 'wechat' })

---

authenticateWithBiometric

生体認証（指紋 / 顔）を開始します。

try {
  const result = await woo.authenticateWithBiometric({
    reason: '请验证身份以完成支付',
  })
  console.log('认证成功', result)
} catch (err) {
  if (err.code === BridgeErrorCode.BiometricCancelled) {
    console.log('用户取消了认证')
  }
}

cancelBiometricAuthentication

進行中の生体認証をキャンセルします。

await woo.cancelBiometricAuthentication()

---

requestAuthorizationToken

認可トークンを取得します。

const result = await woo.requestAuthorizationToken({
  scope: 'user:read',
})
console.log(result.token)

---

getUserProfile

ユーザーのプロフィールを取得します。

const profile = await woo.getUserProfile()
console.log(profile.nickname, profile.avatar)

完全な例：ログインフロー

Vue

<script setup>
import woo from 'mini-sdk'
import { BridgeErrorCode } from 'mini-sdk'

async function login() {
  woo.showLoading('登录中...')

  try {
    // 1. SSO 登录获取授权码
    const { code } = await woo.requestSSOLogin()

    // 2. 用授权码换取 Token
    const res = await woo.request.post('/api/auth/login', { code })
    const { token } = res.data

    // 3. 保存 Token
    await woo.setStorage({ key: 'token', data: token })

    // 4. 获取用户信息
    const profile = await woo.getUserProfile()
    await woo.setStorage({ key: 'profile', data: profile })

    woo.showToast({ title: '登录成功', icon: 'success' })
    woo.reLaunch('/pages/index/index')
  } catch (err) {
    if (err.code === BridgeErrorCode.UserCancelled) {
      woo.showToast({ title: '已取消登录', icon: 'none' })
    } else {
      woo.showToast({ title: '登录失败', icon: 'none' })
    }
  } finally {
    woo.hideLoading()
  }
}
</script>

React

import { useCallback } from 'react'
import woo from 'mini-sdk'
import { BridgeErrorCode } from 'mini-sdk'

function LoginFlow() {
  const login = useCallback(async () => {
    woo.showLoading('登录中...')

    try {
      const { code } = await woo.requestSSOLogin()
      const res = await woo.request.post('/api/auth/login', { code })
      const { token } = res.data
      await woo.setStorage({ key: 'token', data: token })
      const profile = await woo.getUserProfile()
      await woo.setStorage({ key: 'profile', data: profile })
      woo.showToast({ title: '登录成功', icon: 'success' })
      woo.reLaunch('/pages/index/index')
    } catch (err) {
      if (err.code === BridgeErrorCode.UserCancelled) {
        woo.showToast({ title: '已取消登录', icon: 'none' })
      } else {
        woo.showToast({ title: '登录失败', icon: 'none' })
      }
    } finally {
      woo.hideLoading()
    }
  }, [])

  return <button onClick={login}>登录</button>
}

型定義

interface SSOLoginResult {
  code: string
  state: string
}

interface LinkedLoginOptions {
  provider: string
  scope?: string
}

interface LinkedLoginResult {
  token: string
}

interface SubmitAccountLinkOptions {
  provider: string
  credential: string
  verificationCode?: string
}

interface BiometricOptions {
  reason?: string
}

interface BiometricResult {
  success: boolean
}

interface RequestAuthorizationTokenOptions {
  scope: string
}

interface AuthTokenResult {
  token: string
  expiresIn: number
}

interface UserProfile {
  nickname: string
  avatar: string
  [key: string]: unknown
}

早見表

メソッド	説明	シグネチャ
login	ログインを開始する	() → Promise<{ code }>
checkSession	セッションが有効かどうかを確認する	() → Promise<{ valid }>
getUserInfo	ユーザー情報を取得する	() → Promise<UserInfo>
getUserProfile	ユーザー情報を取得する（ポップアップの同意）	({ desc }) → Promise<UserInfo>
authorize	権限を明示的に要求する	({ scope }) → Promise<void>
getSetting	付与済みの権限一覧を取得する	() → Promise<{ authSetting }>
openSetting	権限設定ページを開く	() → Promise<{ authSetting }>