开发者指南

更新时间:
复制为 MD 格式

通过开放平台,开发者可以浏览和订阅 API 产品进行接口调用。本文介绍如何注册开发者账号、浏览和订阅 API 产品,以及创建和管理消费者凭证的完整操作流程。

注册开发者账号

开发者需先完成账号注册,获得访问门户的权限后,方可浏览和订阅 API 产品。开放平台支持账号密码注册和 OIDC 登录两种方式。

账号密码注册

使用用户名和密码创建本地开发者账号。

  1. 访问开发者门户首页,在登录区域点击注册按钮,进入注册页面。

  2. 填写注册信息,包括用户名和密码。

  3. 确认信息无误后,点击注册按钮提交申请。

OIDC 登录注册

若管理员已配置 OIDC 登录(如企业 SSO),可直接使用企业账号登录,首次登录时系统会自动创建开发者账号。

  1. 访问开发者门户首页,在登录区域点击 OIDC 登录按钮(如阿里云账号登录)。

  2. 跳转至企业身份提供商(IdP)的登录页面。

  3. 在企业 IdP 中完成身份验证。

  4. 授权完成后自动跳转回开放平台,系统自动创建开发者账号并完成登录。

说明

使用 OIDC 方式登录的开发者无需设置密码,首次登录后账号状态即为已审批,可直接使用。

注册审批

通过账号密码提交注册申请后,账号生效状态取决于门户的审批配置:

  • 自动审批模式:注册申请提交后立即生效,可直接使用账号登录门户。

  • 手动审批模式:注册申请需等待管理员在后台审批通过后方可登录使用。

重要

使用 OIDC 登录的用户默认自动完成审批,无需等待管理员审核。

浏览和订阅 API 产品

成功登录门户后,可浏览平台上已发布的各类 API 产品,并根据业务需求申请订阅。

浏览产品

  1. 使用注册的开发者账号登录开发者门户。

  2. 在导航栏进入模型MCP智能体 等产品页面。

  3. 浏览产品列表,查看产品名称、功能描述和所属类别,通过筛选和搜索快速定位目标产品。

  4. 点击感兴趣的产品卡片进入详情页,查看产品功能介绍、使用指南和调用示例等信息。

订阅产品

在订阅 API 产品前,需先创建消费者并获取对应的调用凭证。

  1. 在产品详情页中查看产品信息后,点击订阅按钮,发起订阅申请。

  2. 从消费者列表中选择要用于该产品调用的消费者身份。

    说明

    每个开发者注册成功后,系统会自动创建一个默认消费者。如需创建更多消费者,请参见本文档管理消费者凭证章节。

  3. 点击确定订阅按钮,提交订阅申请。

订阅申请提交后,最终生效状态取决于门户的审批配置:

  • 自动审批:订阅申请立即生效,可通过消费者凭证访问 API 产品。

  • 手动审批:订阅申请需等待管理员审批通过后方可调用。

管理消费者凭证

开放平台使用消费者作为 API 调用的身份凭证。每个开发者注册成功后,系统会自动为其创建一个默认消费者。

创建消费者

  1. 登录开发者门户后,点击右上角头像展开菜单,选择进入消费者管理页面。

  2. 在消费者列表页面点击新增消费者按钮。

  3. 填写消费者信息:

    字段

    说明

    消费者名称

    用于标识该消费者的名称,建议按照用途命名(例如 my-app-prod),必填。

    描述

    简要说明该消费者的用途(例如用于生产环境调用),选填。

  4. 确认信息填写完整后,点击提交按钮,完成创建。

查看和管理凭证

消费者创建成功后,系统会自动生成 API Key 作为调用凭证。

  1. 在消费者列表中找到目标消费者,点击查看凭证按钮,查看该消费者的 API Key。

  2. 复制 API Key,在 API 调用时将其添加到请求头中进行身份认证。

  3. 如需废弃该凭证,可点击删除按钮进行删除,删除后该凭证立即失效。