MagicPodではユーザ向けのWeb APIを公開しています。WebAPIを通じて取得できる情報についてはこちらのページの各APIの説明をご確認ください。
MagicPod Web APIを用いたテスト結果の管理方法については下記ページにまとめています。
目次
1. MagicPod Web APIの使用方法
1. APIトークンを取得する
MagicPodにログインし、こちらのページでAPIトークンをコピーしてください。
2. 認証情報を入力する
MagicPod Web API(v1.0)にアクセスし、右上にある「Authorize」ボタンをクリックし、手順1でコピーしたAPIトークンを「Token [API token]」の形式で入力してください。頭にTokenと半角空白をつけずにAPIトークンのみを入力すると認証エラーとなるため注意してください。
「Authorize」ボタン
APIトークン入力画面
3. Web APIを実行する
本サイト上でWeb APIコールを行うことが可能です。任意のWeb API行をクリックし、「Try it out」ボタンをクリックしてください。その後各入力ボックスに情報を入力し、「Execute」ボタンをクリックしてください。赤字で「* required」と記載されている項目については必ず入力してください。
「Try it out」ボタン
入力ボックスと「Execute」ボタン
4. 実行結果を確認する
実行が成功するとHTTPのステータスコード 200が返り、取得した情報を確認することができます。Curlコマンドも生成されますので、こちらを手元のコマンドラインツールでの確認やCIツールへの組み込み等にご利用ください。
レスポンス例
2. POSTリクエスト実行時の注意点
POSTリクエストの中には、リクエストパラメータとしてdataオブジェクトが必須となっているものがあります。「Example Value」をクリックすると、値の入力例が表示されます。「Try it out」をクリックし、値を編集してください。
「Execute」ボタンを押しても何もレスポンスが返ってこない場合、以下を確認してください。
データの型情報が正しいか
データの型情報を参照し、入力値が正しいか確認してください。
例えば、string型の項目にダブルクオテーションなしで入力していると、APIが実行されません。
| string |
文字列。ダブルクオテーションが必要 |
| integer |
数値。ダブルクオテーションは不要 |
| boolean |
真偽値。ダブルクオテーションは不要 |
カンマの有無など、記法上の誤りがないか
- 行末にカンマ（,）を入れる
- 最後の項目の行末にはカンマ（,）を入れない
など、JSON形式のフォーマットに誤りがないか確認してください。
下記はJSON形式の記述例です。
{
"environment": "magic_pod",
"browser": "chrome"
}
Tips: POST /v1.0/{organization_name}/{project_name}/batch-run/におけるdataオブジェクト設定方法
POST /v1.0/{organization_name}/{project_name}/batch-run/を利用する際のdataオブジェクトは、下記の方法で取得することも可能です。
1. プロジェクトのページの「テスト一括実行」タブで、「詳細」ボタンをクリックします。
2. 画面右上の「︙」> 「コマンドラインで実行」をクリックします。
3. 「curlで実行（Mac/Linuxターミナル）（詳細設定）」を選択し、下部に表示されるコマンド内のtest_settingsの[ ]内をコピーします。
4. テキストエディタ等で「\」を消去し、Web APIのdataオブジェクト欄に貼り付けます。
3. APIリクエスト制限
MagicPod Web APIには、ユーザごとに適用されるリクエスト数の制限があります。
- 1ユーザーあたり、1分間に最大100回のAPIリクエストが可能です。
- 制限は全てのAPI(URL)に共通して適用されます。たとえば、一括実行のリストを取得するAPIを10回、個別の一括実行結果を取得するAPIを90回使用した場合、合計で100回と数え、それ以上のリクエストは一時的に受け付けません。
この制限は、システムの過負荷を防ぎ、すべてのユーザーに対して公平で安定したアクセスを提供するために設定されています。制限に達した場合は、ステータスコード429(too many requests)のエラーが返されます。短時間でリクエスト可能な状態にリセットされますので、少しお待ちいただければ再びAPIをご利用いただけます。