Apidog は、API リクエスト向けにさまざまな認証方法を提供しており、連携を保護し、保護されたリソースへアクセスできるようにします。このページでは、サポートされているすべての認可タイプと、Apidog での設定方法について包括的なリファレンスを提供します。リクエストの Authorization セクションにある Type メニューから認証タイプを選択できます。認証はリクエスト、フォルダー、またはコレクションのレベルで適用できるため、API ワークスペース全体で認証情報を管理する方法に柔軟性があります。認可タイプの比較#
| Type | ユースケース | セキュリティレベル | 一般的な用途 |
|---|
| Inherit from Parent | 親フォルダー／コレクションの認証を再利用 | さまざま | 共有認証を使用するリクエストの整理 |
| No Auth | パブリックエンドポイント | なし | ヘルスチェック、公開データ |
| API Key | シンプルなトークンベース認証 | 中 | 内部 API、基本的な連携 |
| Bearer Token | トークンベース認証（JWT など） | 中〜高 | モダン API、マイクロサービス |
| JWT Bearer | 自己生成 JWT トークン | 高 | カスタム JWT 実装 |
| Basic Auth | ユーザー名／パスワード | 低〜中 | レガシーシステム、シンプルな認証 |
| Digest Auth | 暗号化されたユーザー名／パスワード | 中 | Basic Auth より強化されたセキュリティ |
| OAuth 1.0 | 委任認可（レガシー） | 中 | Twitter API、レガシーサービス |
| OAuth 2.0 | モダンな委任認可 | 高 | Google、GitHub、Microsoft API |
| Hawk Authentication | HMAC ベース認証 | 高 | 特殊なセキュア API |
| NTLM | Windows 認証 | 中 | Microsoft 環境 |
| Akamai EdgeGrid | Akamai CDN 認証 | 高 | Akamai サービス |
親から継承#
「Inherit from Parent」は、Apidog のデフォルト認証タイプです。リクエストの認証タイプが「Inherit from Parent」に設定されている場合、その親フォルダーから認証設定を継承し、さらにルートフォルダーまで継承を続けます。これにより、フォルダーレベルで認証を一度設定するだけで、すべての子リクエストに自動的に適用できます。
認証なし#
認証が不要な場合、Apidog は認可の詳細を含めません。認証なしのリクエストでは、Authorization タブの Type ドロップダウンから No Auth を選択するだけです。API Key#
API キー認証では、リクエストヘッダーまたはクエリパラメータのいずれかにキーと値のペアを指定します。Type オプションから API Key を選択し、キー名と値を入力して、Headers または Query Params のどちらに追加するかを選択します。Apidog は、必要な情報をリクエスト Headers または URL クエリ文字列に自動的に追加します。セキュリ ティを強化するため、API キーをリクエストにハードコードするのではなく、環境変数に保存してください。これにより、バージョン管理や共有ワークスペースでの意図しない公開を防止できます。
Bearer Token#
JSON Web Tokens（JWT）などの Bearer トークン認証では、リクエストヘッダー内のアクセスキーを使用します。Type リストから Bearer Token を選択し、Token フィールドに API キーを入力します。Apidog は、次の形式で Authorization ヘッダーにトークンを追加します。「Bearer」以外のカスタムプレフィックスを使用する場合は、キー名を「Authorization」として API Key オプションを使用してください。
JWT Bearer#
Apidog は、アプリケーション内での JWT トークン生成にも対応しています。Type オプションから JWT Bearer を選択します。Location: トークンを Request Header または Query Param に追加します
Algorithm: SHA を使用する HS、RS、ES、または PS のバリアントから選択します
Secret/Key: 必要なシークレットまたは秘密鍵を入力します
Payload: JSON 形 式でペイロードデータを入力します
Basic Auth#
Basic 認証では、検証済みの認証情報をリクエストとともに送信します。Type メニューから Basic Auth を選択し、API のユーザー名とパスワードを入力します。Apidog は、認証情報を Base64 エンコードした文字列を含む Authorization ヘッダーを、次の形式で含めます。Basic <Base64 encoded username and password>
Basic Auth は認証情報を Base64 エンコードで送信しますが、これは容易にデコードできます。Basic Auth を使用する場合は必ず HTTPS を使用し、本番環境では OAuth 2.0 など、より安全な代替手段を検討してください。
その他の認可タイプ#
Apidog は、次の高度な認可方法にも対応しています。NTLM - Windows NT LAN Manager 認証 