DK-Agora AI
使用指南

开发者API使用指南

使用DK-Agora AI开发者API可从外部应用创建、查询、加密/解密备忘录。生成API密钥通过RESTful API以编程方式使用DK-Agora AI功能。

第1步: 访问开发者门户

在地址栏输入/developer,或在顶部「资源」菜单点击「API文档」。需要登录。

第2步: 生成API密钥

在开发者门户点击「生成新API密钥」按钮。设置密钥名称和权限范围。生成的API密钥仅显示一次,务必存储在安全的地方。

第3步: 使用API

API请求时在Authorization头中以Bearer令牌包含API密钥。主要端点:GET /api/v1/memos(列表)、POST /api/v1/memos(创建)、POST /api/v1/encrypt(加密)、POST /api/v1/decrypt(解密)。

第4步: 查看使用量

在开发者门户查看API调用次数、按日/月统计。超过计划的API调用限额时返回429错误。

第5步: 参考API文档

在/developer/docs页面查看完整API参考。提供每个端点的请求/响应格式、错误代码、示例代码。

开发者API提示

  • -不要将API密钥直接包含在代码中,请用环境变量管理。
  • -立即删除未使用的API密钥。
  • -检查错误响应的状态码和消息进行调试。
  • -达到速率限制时稍后重试,或考虑升级计划。