Apidog Docs
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
HomeLearning CenterSupport CenterAPI References
HomeLearning CenterSupport CenterAPI References
Discord Community
Slack Community
X / Twitter
🇯🇵 日本語
  • 🇺🇸 English
  • 🇯🇵 日本語
  1. ベストプラクティス
  • Apidog学習センター
  • はじめに
    • Apidog紹介
    • Apidog基本操作
      • 概要
      • 新しい APIを作成
      • APIにリクエストを送信
      • アサーションを追加
      • テストシナリオを作成
      • APIドキュメントを共有
      • さらなる探究
      • リクエストを送信してAPIとして保存
    • Apidog基本知識
      • Apidog操作方法
      • Apidogの基本概念
    • 移行
      • 概要
      • 手動インポート
      • 定期インポート
      • インポートオプション
      • データのエクスポート
      • Import from...
        • Postman からインポート
        • OpenAPI(Swagger)仕様のインポート
        • cURLのインポート
        • Markdownのインポート
        • Insomniaからのインポート
        • apiDocからのインポート
        • .harファイルのインポート
        • WSDLのインポート
  • API設計
    • 概要
    • コンポーネント
    • 常用フィールド
    • グローバルパラメータ
    • API変更履歴
    • プロジェクトの作成
    • 一括API管理
    • APIの基本
    • 複数のリクエストボディ例の設定
    • Schemas
      • 概要
      • 新規Schemaの作成
      • スキーマを構築する
      • JSONなどからのSchema生成
    • Security schemes
      • 概要
      • Security Schemeの作成
      • Security Schemeの使用
      • オンラインドキュメントにおけるSecurity Scheme
    • 高度な機能
      • APIをテストステップとしてインポート
      • パラメータリストの表示形式
      • APIのカスタムフィールド
      • APIのステータス
      • API固有識別子
  • API開発とデバッグ
    • 概要
    • リクエストの生成
    • リクエストの送信
    • コード生成機能
    • APIケース
    • 動的な値
    • レスポンスの検証
    • 設計優先 & リクエスト優先
    • 環境 & 変数
      • 概要
      • 環境とサービス
      • 変数の使い方
    • Vault secrets
      • 概要
      • AWS Secrets Manager
      • Azure Key Vault
      • HashiCorp Vault
    • 前/後処理
      • 概要
      • Wait
      • 変数の抽出
      • アサーション
      • データベース操作
        • 概要
        • MongoDB
        • Redis
        • Oracle クライアント
      • スクリプト利用
        • 概要
        • 前処理スクリプト
        • 後処理スクリプト
        • Postmanスクリプトリファレンス
        • 共通スクリプト
        • 他のプログラミング言語の呼び出し
        • JSライブラリの使用
        • レスポンスの可視化
        • スクリプトの例
          • その他の例
          • スクリプトを使用したリクエストメッセージの変更
          • スクリプトでの変数の使用
          • アサーションスクリプト
    • 動的値モジュール
  • APIモック
    • 概要
    • スマートMock
    • カスタムMock
    • Mockの優先順位
    • Mockスクリプト
    • クラウドMock
    • セルフホストランナーMock
    • Mock言語 (ロケール)
  • 自動テスト
    • 概要
    • テストレポート
    • テストシナリオ
      • テストシナリオの作成
      • 他のプロジェクトからAPI/APIケースをインポートする
      • リクエスト間でデータを渡す
      • API/APIケースからのデータ同期
      • フロー制御条件
      • テストシナリオのエクスポート
    • テストシナリオ実行
      • データ駆動型テスト
      • スケジュールタスク
      • テストシナリオを一括実行する
      • 他のプロジェクトのAPIの実行環境を管理する
      • テストシナリオを実行する
    • APIテスト
      • 統合テスト
      • 回帰テスト
      • エンドツーエンド(E2E)テスト
      • パフォーマンステスト
    • Apidog CLI
      • 概要
      • Apidog CLIのインストールと実行
      • Apidog CLI オプション
    • CI/CD
      • 概要
      • Jenkinsとの連携
      • Gitlabとの統合
  • APIドキュメント公開
    • 概要
    • Google AnalyticsとDoc Sitesの連携
    • CORS プロキシ
    • クイック共有
    • 可視性設定
    • ドキュメントURLに値を埋め込む
    • APIドキュメントを表示する
    • フォルダツリー設定
    • API SEO設定
    • カスタムレイアウト
    • ドキュメント検索
    • カスタムドメイン
    • ドキュメントサイトの公開
    • APIバージョン
      • 概要
      • APIバージョンの作成
      • APIバージョンの公開
      • APIバージョンごとにAPIの共有
  • リクエスト送信
    • 概要
    • GraphQL
    • gRPC
    • WebSocket
    • SSEデバッグ
    • SOAP/Webサービス
    • デバッグ用のリクエストプロキシエージェントを使用する
    • Socket.IO
    • リクエスト作成
      • リクエストの基本
      • パラメータとボディ
      • リクエストヘッダー
      • リクエスト設定
      • HTTP/2
      • リクエスト履歴
    • 認証と認可
      • 概要
      • CAとクライアント証明書
      • Apidogがサポートする認可タイプ
      • Digest Auth
      • OAuth 1.0
      • OAuth 2.0
      • Hawk Authentication
      • Kerberos
      • NTLM
      • Akamai EdgeGrid
    • レスポンスとクッキー
      • 概要
      • ApidogのAPIレスポンス
      • Cookieの作成と送信
      • リクエストのデバッグ
      • リクエストをAPIとして保存
  • ブランチ管理
    • 概要
    • 新しいスプリントブランチの作成
    • スプリントブランチの管理
    • ブランチ内でのAPIテスト
    • ブランチでAPIの設計
    • スプリントブランチのマージ
  • Apidog MCP Server
    • 概要
    • Apidogプロジェクト内のAPI仕様をApidog MCPサーバー経由でAIに接続する
    • Apidogが公開したオンラインAPIドキュメントをApidog MCPサーバー経由でAIに接続する
    • Apidog MCPサーバーを介してOpenAPIファイルをAIに接続する
  • ベストプラクティス
    • ガイド:ChatGPT APIのトークンとコスト計算
    • Apidog コラボレーションワークフロー
    • API署名の取り扱い方法
    • Apidogでの認証状態の管理
    • OAuth 2.0で保護されたAPIにアクセスする方法
  • 管理
    • オンボーディングチェックリスト
      • 基本概念
      • Apidogスタートアップガイド
    • チーム管理
      • チーム管理
      • チームメンバーの管理
      • メンバーの役割と権限設定
      • チーム活動
      • チームリソース
        • 一般ランナー
        • チーム変数
        • リクエストプロキシエージェント
        • データベース接続
      • リアルタイムコラボレーション
        • チームコラボレーション
    • プロジェクト管理
      • プロジェクト管理
      • プロジェクトメンバーの管理
      • 通知設定
    • 組織管理
      • シングルサインオン(SSO)
        • 概要
        • Microsoft Entra IDの設定
        • Okta設定
        • 組織のSSOを設定する
        • チームへのグループのマッピング
        • ユーザーアカウントの管理
      • SCIMプロビジョニング
        • SCIMプロビジョニング入門
        • Microsoft Entra ID
        • Okta
      • 組織リソース
        • セルフホストランナー
  • 請求情報
    • 概要
    • プランのアップグレード
    • クレジット
    • クレジットカードが使えない?
    • サブスクリプションの管理
  • アドオン
    • API Hub
    • Apidog IntelliJ IDEA プラグイン
    • リクエストプロキシ
      • Apidogウェブでのリクエストプロキシ
      • 共有ドキュメントでのリクエストプロキシ
      • Apidogクライアントでのリクエストプロキシ
    • ブラウザ拡張機能
      • Microsoft Edge
      • Chrome
  • アカウント & 設定
    • アカウント設定
    • 言語設定
    • データバックアップ
    • ネットワークプロキシ設定
    • ホットキー
    • Apidogの更新
    • OpenAPIアクセストークンの生成
    • アカウント削除
  • 参考資料
    • Swagger拡張機能
    • Socket通信:パケットの分断と結合
    • 用語の説明
    • よくある質問
    • API-デザインファーストアプローチ
    • Apidog OpenAPI/Swagger仕様拡張
    • JSONPath
    • XPath
    • 正規表現
    • JSONスキーマ
    • CSVファイルフォーマット
    • Java環境のインストール
    • ランナーのデプロイ環境
    • ApidogフレーバーMarkdown
  1. ベストプラクティス

Apidogでの認証状態の管理

認証はAPIテストと開発において重要な要素です。認証状態を適切に管理することで、APIリクエストが安全で効率的になり、実際の使用シナリオを正確に反映できます。このガイドでは、強力なAPI開発およびテストプラットフォームであるApidogでの認証状態の取り扱いに焦点を当てます。
このガイドは、Apidog内で認証状態を効果的に管理するのに役立ちます。

一般的な認証方法#

1. セッション/クッキー方式#

Apidogはセッションとクッキーを通じて自動的に認証状態を維持します。
使用方法:
ログインAPIを実行すると、グローバルCookieに返されたセッション/クッキー情報が保存されます。
後続のAPI呼び出しには、このセッション/クッキー情報が自動的に含まれます。
TIP
セッション/クッキーによる自動ログインの実装については、以下の「自動ログインの実装」セクションを参照してください。

2. トークンベース認証#

トークンベース認証では、APIリクエストのパラメータ(通常はHeader)にログイン認証情報を含めます。一般的な方法には、Basic Auth、Bearer Token、API Keyなどがあります。
実装方法:
1.
認証情報をグローバル(プロジェクト概要ページ)、グループレベル(グループ設定)、または個々のAPI(ドキュメントページ)で設定します。サポートされている認証タイプは以下の通りです:
認証タイ��プ
2.
トークンをHeaderや他の関連パラメータに手動で追加します。トークンの保存には環境変数の使用を推奨します。例:
Bearer Token: Authorizationという名前のHeaderを設定し、値にBearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9yJpZCI6を指定するか、環境変数を使用します:Bearer {{AUTH_TOKEN}}。
3.
グローバルパラメータに値を設定します。すべてのAPIは実行時に自動的にグローバルパラメータを含むため、APIごとに手動で設定する必要はありません。
TIP
トークンによる自動ログインの実装については、以下の「自動ログインの実装」セクションを参照してください。

3. 自動ログイン方式#

この方法では、手動での介入なしにログインAPIを自動的に呼び出して認証を完了します。

自動ログインの実装#

期待される結果#

1.
手動での介入なしにログインAPIが自動的に呼び出される。
2.
ログイン成功後に認証状態が保持され、冗長なログインAPI呼び出しを避ける。

ステップバイステップガイド#

1.
環境変数(例:ACCESS_TOKEN)を使用してログイン認証情報を保存します。
2.
認証情報に有効期限がある場合、環境変数(例:ACCESS_TOKEN_EXPIRES)を使用してこの情報を保存します。
3.
以下の内容のパブリックスクリプトを作成します:
a. ACCESS_TOKENに値があり、ACCESS_TOKEN_EXPIRESがまだ有効かどうかを確認します。有効であれば実行を続行し、そうでなければ次のステップに進みます。
b. pm.sendRequestを使用してログインAPIを呼び出し、返された認証情報と有効期限を環境変数に書き込みます。
4.
認証が必要なAPIを設定します:
a. 認証検証パラメータを{{ACCESS_TOKEN}}に設定します。
Authorizationヘッダーを{{ACCESS_TOKEN}}に設定するか、必要に応じてクッキーや他のパラメータを使用します。
または、グローバルパラメータに値を設定して、すべてのAPI呼び出しに自動的に含まれるようにします。
b. 上記で作成したパブリックスクリプトを前処理スクリプトで参照します。

パブリックスクリプトの例#

TIP
このスクリプトのログイン認証情報は、LOGIN_USERNAMEとLOGIN_PASSWORD環境変数から取得されます。このコードを使用する場合は、これらの環境変数を設定してください。
トークンに有効期限がない場合は、ACCESS_TOKEN_EXPIRES関連のコードを削除してください。
pm.sendrequestのドキュメントについては、こちらをクリック。
pm.cookiesのドキュメントについては、こちらをクリック。
このスクリプトは、Apidogで自動ログインを実装するための堅牢な基盤を提供します。特定のAPI要件に応じて、ログインリクエストの構造とレスポンスの処理を調整することを忘れないでください。
Previous
API署名の取り扱い方法
Next
OAuth 2.0で保護されたAPIにアクセスする方法
Built with