认证
Reigniter API 使用API 密钥。每个密钥属于一个账户,作为该账户运作:它花费该账户的积分,只看到该账户的作业。
创建一个密钥
Section titled “创建一个密钥”API 密钥是 Agency 套餐的一部分。
- 登录 Reigniter。
- 开 启账户> API 密钥 (
/app/account/api-keys)。 - 在 “创建新键”中输入你以后会认出的标签,比如
CI pipeline或CMS sync。 - 选择 创建。
- 马上复制密钥。
一个关键字如下: emp_ 后跟64个十六进制字符。
每次请求都将密钥作为承载令牌放入 Authorization 头:
curl https://reigniter.ai/v1/me \ -H "Authorization: Bearer $REIGNITER_API_KEY"有效的密钥会 200 你的账户:
{ "user_id": "3f1c2a9e-8b7d-4c1e-9f0a-2d6b5e4c3a21", "email": "dev@example.com", "name": "Sam", "credits_remaining": 42}当密钥被拒绝时
Section titled “当密钥被拒绝时”| 现状 | code |
含义 |
|---|---|---|
401 |
NO_API_KEY |
没有 Authorization 首部,或者令牌不以 emp_ 开头。 |
401 |
INVALID_API_KEY |
密钥未知或已被吊销。 |
402 |
PLAN_UPGRADE_REQUIRED |
密钥有效,但账户不在 Agency 套餐上。 |
403 |
ACCOUNT_SUSPENDED |
拥有密钥的账户会被暂停。 |
如果账户退出 Agency 套餐,其密钥会停止工作,直到重新 Agency。
- 把密钥存到秘密管理器或环境变量里。绝不要把它们提交到源代码控制。
- 只在你的服务器上拨打 API 。绝不要在网页或移动应用中发送密钥。而且浏览器请求 API 的CORS政策也不允许。
- 每个系统只用一个密钥,标签清晰。这样你可以撤销其中一个,而不会损坏其他的。
- API键界面显示每个键最后使用的时间。你不认识的密钥,或者在不该使用时使用的密钥,应当被撤销。
- 开 设账户> API 密钥。
- 在 “活跃密钥”中,通过标签找到密钥。
- 选择 撤销键 (bin)图标。
被撤销的密钥会立即被拒绝,并 401 INVALID_API_KEY。撤销无法撤销。已经用密钥开始渲染的渲染继续运行。