MagicPodが提供するWeb APIの使用方法

MagicPodではユーザ向けのWeb APIを公開しています。WebAPIを通じて取得できる情報についてはこちらのページの各APIの説明をご確認ください。

MagicPod Web API(v1.0)

MagicPod Web APIを用いたテスト結果の管理方法については下記ページにまとめています。

テスト結果を管理する方法が知りたい

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ツールへの組み込み等にご利用ください。

レスポンス例