Skip to content

身份验证

On this page

每个请求到CurriculoAPI都携带开发者控制台密钥作为bearer令牌:

Authorization: Bearer key_<id>_<secret>
curl -X POST https://api.curriculo.me/public/detect-language/ \
  -H 'Authorization: Bearer key_abc123_yoursecret' \
  -H 'Content-Type: application/json' \
  -d '{"text": "Ingeniera de software con diez años de experiencia"}'

一个密钥,所有操作

控制台密钥在创建时即可用于所有操作。没有每个端点的凭证,没有作用域和每个能力的请求。没有ATS登录,没有会话cookie和没有组织头部参与。

获取API密钥

登录到 开发者控制台 ,并打开 API密钥.

  • 每个密钥可以携带一个名称和一个 可选的过期。没有过期时间的密钥在被吊销之前一直有效。
  • 明文值在创建时返回 一次。只存储16个字符的前缀和一个SHA-256哈希,因此丢失的密钥被替换,而不是恢复。
  • 吊销是立即的。 下一个使用被吊销密钥的请求将 401.
  • 一个账户可以持有最多25个活跃密钥。

密钥需要服务流量

当账户的密钥被接受时:

  • 已经完成了预配(这在第一次登录时发生);
  • 具有预付信用余额大于零(新账户以$5.00免费信用开始);
  • 未被暂停.

关键字卫生

将API密钥视为密码。绝不将其提交到源代码控制或粘贴到不受信任的客户端中,并在其暴露后立即撤销.

  • 为每个环境或团队 发行单独的密钥,以保持可归因的使用并使每个密钥独立可撤销.
  • 密钥范围限定于您的组织 ,且只能看到组织内的内容.
  • 密钥不能管理账户。 它不能创建新密钥或更改计费信息,因此泄露的密钥永远不会升级为账户控制.

身份验证错误

状态消息如何处理
401"缺少 API 令牌…"发送 Authorization: Bearer 头部.
401"无效 API 令牌."密钥未知或已撤销。创建新密钥.
401"API 令牌已过期."密钥已过期。创建新密钥.
401"未知 API 端点"/public/ 下的路径不存在。检查拼写和末尾斜杠.
403没有预付信用("…在控制台中购买信用.")在 控制台 → 计费中添加信用.
403账户已暂停联系我们.
403"首次登录后,请等待配置完成。

请参阅 错误 ,以获取完整列表。

Updated