开发者 · 公开 API 与接入指南

公开 API

基址是 https://karmenloop.com。机器可读的说明在 /api/public/v1。

读取说明

GET /api/public/v1

返回接口列表，以及哪些已经开放、哪些还没有开放。

提交申请

POST /api/public/v1/applications

申请一键登录或 SDK。请求成功会立刻返回申请编号，状态是已收到。

用户确认

GET /api/public/v1/oauth/authorize

POST /api/public/v1/oauth/token

这两个地址可以调用，但现在返回未开放。申请编号不能换成令牌。

接入指南

按这个顺序做。没有核对通过之前，不要向使用你软件的人展示一个会成功的登录按钮。

准备软件名称、https 网址、联系邮箱，以及一段说明。
如果要一键登录，再准备 1 到 5 个 https 回调地址。本地地址和 http 地址不会被接受。
调用申请接口，或使用本页下面的表单。保存返回的申请编号。
核对通过后，我们会按你留下的邮箱发送授权地址和接入参数。在那之前，授权地址和换令牌接口都返回未开放。
核对通过之后，把按钮指到发给你的授权地址。人在浏览器里确认后，会回到你登记的回调地址，并带上一次性授权码。
用授权码调用换令牌接口。令牌只放在这台电脑上，不要放进网页源代码，也不要拿它读取模型密钥。

一键登录的请求

curl -X POST https://karmenloop.com/api/public/v1/applications \
  -H 'content-type: application/json' \
  -d '{"productName":"示例软件","site":"https://example.com","contact":"dev@example.com","kind":"one-click-login","redirectUris":["https://example.com/callback"],"summary":"为使用的人提供一键登录"}'

SDK 的请求

在自己的程序里调用这台电脑上的 Koder，用 Koder SDK 0.1.1。下面这份申请是公开接口，不是那个仓库。把 kind 改成 sdk，并写明要调用的能力。SDK 申请不需要回调地址。

curl -X POST https://karmenloop.com/api/public/v1/applications \
  -H 'content-type: application/json' \
  -d '{"productName":"示例 SDK","site":"https://example.com","contact":"dev@example.com","kind":"sdk","summary":"在自有软件里调用 Koder 的公开接口"}'

现在还没有的

Koder 里还没有账号登录，账户页写着没有云端账号。使用 Koder 不需要注册。
申请编号不是访问令牌，也不能用来登录。
公开接口不提供模型密钥，也不代替别人的软件登录。

直接申请

表单和上面的接口收的是同一份内容。提交后页面会显示申请编号。

文档对应的是网站，不是软件里的一页

Koder 窗口里没有公开接口的控制台。设置 → 账户与个人资料写着没有云端账号，侧栏底部是“本地使用 / 未登录 · 不同步”。第三方要接的是本站的公开 API：读取说明、提交一键登录或 SDK 申请。申请立刻返回 app_ 开头的编号，状态是已收到。

编号只是回执。它不会被存成可以再查的档案，也不能换成令牌。授权地址和令牌地址返回未开放。账号登录还没有提供，所以现在没有用户会话可以授出。