認証
On this page
CurriculoAPIへの毎回のリクエストには、Developer Consoleキーがベアラートークンとして含まれます:
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"}'1つのキー、全操作
コンソールキーは、作成された瞬間から全操作で機能します。エンドポイントごとの資格情報、スコープ、機能ごとのリクエストはありません。ATSログイン、セッションクッキー、組織ヘッダーは関係ありません
APIキーの取得
Developer Console にサインインし、 APIキーのページを開きます.
- 各キーには名前と 任意の期限を付けることができます。期限のないキーは取り消しまで有効です
- 平文値は、作成時に 一度、返されます。16文字のプレフィックスとSHA-256ハッシュのみが保存されるため、失われたキーは再発行され、復元されることはありません
- 取消は即時です。 次の要求で取消されたキーが取得されます
401. - アカウントは最大25個のアクティブなキーを保持できます。
トラフィックを提供するためにキーが必要とするもの
アカウントが次の条件を満たしたときにキーは受け入れられます:
- プロビジョニングが完了していること(初回サインイン時に発生します);
- 前払いクレジット残高が0以上であること(新規アカウントは$5.00の無料クレジットから始まります);
- 停止されていないこと。
キー管理
APIキーをパスワードのように扱ってください。ソースコントロールにコミットしたり、信頼できないクライアントに貼付したりしないでください。また、公開された場合はすぐに取消してください。
- 環境やチーム ごとに別々のキーを発行して、使用を特定しやすくし、各キーを独立して取消できるようにします。
- キーのスコープは組織 内に限定され、他のものは見えません。
- キーの管理がアカウントを管理できない。 キーは新しいキーを作成したり、請求情報を変更したりできないため、漏洩したキーがアカウントの管理権限に昇格することはありません。
認証エラー
| ステータス | メッセージ | 対処方法 |
|---|---|---|
401 | "APIトークンが見つかりません…" | Authorization: Bearer ヘッダーを送信してください。 |
401 | "APIトークンが無効です。" | キーは不明または無効化されています。新しいキーを作成してください。 |
401 | "APIトークンの有効期限が切れています。" | キーは有効期限を過ぎています。新しいキーを作成してください。 |
401 | "不明なAPIエンドポイント" | /public/ 以下のパスが存在しません。スペルと末尾のスラッシュを確認してください。 |
403 | 事前支払いクレジットがありません。("…コンソールでクレジットを購入してください。") | コンソール → 請求書でクレジットを追加してください. |
403 | アカウントが停止されています | お問い合わせください。 |
403 | "アカウントのプロビジョニングが完了していません" | 最初のサインイン後にプロビジョニングが完了するまで待ってください。 |
エラー を参照して、エラーリストを全て見てください。
Updated