Skip to main content

应用用户的登录与注册

概述​

tip

该接口主要用户实现 AI 应用本身的用户登录注册功能。

模力方舟为应用的每一个用户提供了身份认证接口，开发者可以通过该接口来实现用户的身份验证和信息获取。当使用该接口时，系统会为每个用户生成一个用户专属令牌，应用应该使用这个用户专属令牌来调用模型 API。调用模型 API 所产生的费用都会汇集到开发者的应用专属资源包中。

这个过程无需最终用户去购买资源包、创建令牌等专业的操作，模力方舟会自动使用开发者的资源包来抵扣用户的模型调用费用。

主要包括如下几个接口：

验证码发送接口​

发送验证码，支持短信或邮箱方式，用于获取应用“用户访问令牌”的验证码。

示例代码：

Python
requests.post("https://ai.gitee.com/v1/app/auth/vcode",
    headers={
      "Authorization": "Bearer {app_access_token}",
      "Content-Type": "application/json"
    },
    json={
      "appid": "", # 应用的 AppID
      "mobile": "", # 用户的手机号码（手机邮箱二选一）
      "email": "", # 用户的邮箱地址
      "channel_type": "sms" # 渠道类型，支持 sms 和 email
    }
)

用户身份认证接口​

校验验证码并获取“用户访问令牌”。获取后，用户可使用该凭证下单、查看订阅信息等。如果某手机或者邮箱尚未注册成为应用的用户，则自动注册。

示例代码：

Python
requests.post("https://ai.gitee.com/v1/app/auth/token",
    headers={
      "Authorization": "Bearer {app_access_token}",
      "Content-Type": "application/json"
    },
    json={
      "appid": "", # 应用的 AppID
      "channel_type": "sms",
      "mobile": "", # 用户的手机号码（手机邮箱二选一）
      "email": "", # 用户的邮箱地址
      "code": "" # 验证码
    }
)

该接口访问用户对应的令牌，可以用该令牌来获取用户信息以及调用模型 API。

{
  "access_token": "string"
}

用户信息获取接口​

获取用户的基本信息，包括用户 ID、手机号、邮箱，以及购买应用的详细信息。

Python
requests.get("https://ai.gitee.com/v1/app/auth/userinfo",
    headers={
      "Authorization": "Bearer {user_access_token}"
    }
)

返回的结果内容如下：

{
  "mobile": "string",
  "email": "string",
  "status": "NORMAL",
  "created_at": 1754633185000,
  "purchase_status": "ACTIVE",
  "pay_plan_ident": "string",
  "usage_expired_at": 1754633185000,
  "amount": 1,
  "balance": 1,
  "subscriptions": [
    {
      "id": "string",
      "pay_plan_ident": "string",
      "billing_type": "SUBSCRIPTION",
      "billing_multiplier": 1,
      "expired_at": 1754633185000,
      "status": "ACTIVE",
      "effective_at": 1754633185000
    }
  ]
}

有了这个用户信息，接下来就可以使用用户的访问令牌来调用模型 API 以及进行 付费操作 了。