REST API で認証する

API キーを使って、ベアラーヘッダー、リクエストボディ、またはクエリパラメータ経由で REST API リクエストを認証する方法。

ほとんどの Roboflow API エンドポイントでは、API キーまたは OAuth アクセストークンが必要です。リクエストは次の api_key 本文とクエリのパラメータ、認証ヘッダー経由、またはクエリパラメータを使用して認証できます。

Roboflow ユーザーの代わりに認証するアプリケーションについては、 Roboflow でサインイン（はじめに）。OAuth アクセストークンは、以下のすべての認証方法で使用できます。

認証ヘッダー

REST API への認証では、API キーをベアラー認証ヘッダーとして送信することをおすすめします。

ヘッダー構造の例は次のとおりです:

Authorization: Bearer abcdefghijklmnopqrstuvwxyz

本文パラメータ

POST エンドポイントの JSON リクエスト本文内のパラメータとして API キーを送信できます。

リクエスト本文で API キーを使用する例は次のとおりです:

{
    "api_key":"abcdefghijklmnopqrstuvwxyz"
}

クエリパラメータ

API キーを、リクエスト URL のクエリパラメータとして送信することもできます。

セキュリティ上の理由から、本番アプリケーションでこの認証方法を使うことはおすすめしません。代わりに認証ヘッダーの送信をおすすめします。

クエリパラメータで送信される API キーの例は次のとおりです:

https://api.roboflow.com?api_key=abcdefghijklmnopqrstuvwxyz