API
API 认证
熵矢 API 的 SK 服务端请求,以及集成应用的 OAuth/Clerk 示例。
使用本页为你的熵矢集成选择合适的认证方式。
- 当你的后端服务直接调用熵矢 API 时,使用 SK。
- 当你的产品需要通过 Clerk/OAuth 完成委托用户授权时,使用集成应用流程。
获取 SK
在应用服务的 系统 -> SK 密钥管理 页面创建并复制 SK。
仅在受信任的后端或服务端环境中保存 SK。不要把 SK 嵌入浏览器代码、移动应用、公开仓库、客户端日志或对客户可见的配置中。
SK 请求示例
后端调用熵矢 API 时,将 SK 作为 bearer token 使用。
curl --request GET \
--url 'https://entropass.com/oxpecker/api/v1/tasks/task_123' \
--header 'Authorization: Bearer sk-xx'
集成应用示例
当你的产品需要对熵矢身份层做委托用户授权,或前端必须在调用受保护 API 之前完成 Clerk bootstrap 时,使用集成应用流程。
准备
- 联系
support@entropass.com,为你的应用完成开通,并登记预期的redirect_uri。 - 在接入授权流程前,确认客户端已拿到所需的
client_id和client_secret。
OAuth 端点
- Authorization URL:
https://clerk.entropass.com/oauth/authorize - Token URL:
https://clerk.entropass.com/oauth/token - User Info URL:
https://clerk.entropass.com/oauth/userinfo
授权码流程
- 将用户重定向到授权 URL,并携带
response_type=code、client_id、redirect_uri、scope和state。 - 在回调 URL 上接收授权码。
- 以
application/x-www-form-urlencoded向 token 端点提交数据,用授权码换取 token。 - 需要刷新访问时,向同一 token 端点使用
grant_type=refresh_token。 - 将得到的 bearer token 发送给需要已认证用户上下文的 API。
前端 Bootstrap 端点
- Endpoint:
GET /biz/api/v1/auth/clerk/publishable-key - Purpose: 返回用于初始化前端 SDK 的 Clerk publishable key。
- Typical sequence:
- 从业务 API 获取 publishable key。
- 在前端初始化 Clerk。
- 使用得到的会话上下文继续授权流程或已认证的 API 调用。
请求示例
curl -X GET 'https://entropass.com/biz/api/v1/auth/clerk/publishable-key'
响应示例
{
"publishableKey": "pk_live_xxx"
}