Apidog Docs
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
Home
Learning Center
Support Center
API References
Home
Learning Center
Support Center
API References
🇯🇵 日本語
🇺🇸 English
🇯🇵 日本語
認証と認可
Copy Page
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
認証と認可
Copy Page
Apidogがサポートする認可タイプ
Apidogは様々な認証方式をサポートしている。リクエストの
認可
セクションの
タイプ
メニューから認証タイプを選択できる。認証はリクエスト、コレクション、フォルダレベルで適用できる。
親から継承
#
「親から継承」はApidogのデフォルトの認可タイプだ。リクエストの認可タイプが「
継承する
」に設定されている場合、親フォルダからの認可を継承し、ルートフォルダまで継承が続く。
No Auth
#
認証が不要な場合、Apidogは 認可情報を含めない。認証不要なリクエストでは、
認可
タブの
タイプ
ドロップダウンから「
No Auth
」を選択する。
API Key
#
APIキー認証では、リクエストヘッダーまたはクエリパラメータにキーと値のペアを提供する。タイプオプションから「
API Key
」を選択し、キー名と値を入力して、
ヘッダー
または
クエリパラメータ
のいずれかに追加する。セキュリティ向上のため、値は変数に保存することを推奨する。
Apidogは必要な情報をリクエストヘッダーまたはURLクエリ文字列に自動的に追加する。
Bearer token
#
JSON Webトークン(JWT )などのBearerトークン認証は、リクエストヘッダーでアクセスキーを使用する。
タイプ
リストから「
Bearer Token
」を選択し、トークンフィールドにAPIキーを入力する。セキュリティ向上のため、変数を使用してトークンを保存・参照することを推奨する。
Apidogは以下の形式でトークンを認可ヘッダーに追加する:
Bearer <Your API key>
カスタムプレフィックスの場合は、キーとして「
Authorization
」を使用するAPIキーオプションを利用する。
JWT
#
ApidogはJWTトークンの生成もサポートしている。
タイプ
オプションから「
JWT
」を選択する。
トークンを
リクエストヘッダー
または
クエリパラメータ
に追加するかを指定し、アルゴリズム(HSやRS、ES、PSのSHAバリアント)を選択して、必要な秘密鍵または秘密キーを入力する。ペイロードデータはJSON形式で入力する。
詳細設定では、ヘッダープレフィックスやカスタムヘッダーを設定できる。
Basic auth
#
基本認証では、検証済みの認証情報をリクエストと共に送信する。
タイプ
メニューから「
Basic Auth
」を選択し、APIのユーザー名とパスワードを入力する。セキュリティ向上のため、これらは変数に保存することを推奨する。
Apidogは以下の形式で、Base64エンコードされた認証情報文字列を含む認可ヘッダーを追加する:
Basic <Base64 encoded username and password>
その他の認可タイプ
#
Apidogは以下の認可もサポートしている:
Digest Auth
OAuth 1.0
OAuth 2.0
Hawk Authentication
NTLM
Akamai EdgeGrid
Previous
CAとクライアント証明書
Next
Digest Auth