mabl APIの概要

mabl APIを使うと、テストのトリガー、結果の取得、テスト実行成果物のエクスポートなどをプログラムから行うことができます。詳細については、以下のトピックをご覧ください。

• 認証
• mabl APIエンドポイント
• レスポンスタイプ
• 重要な概念

認証

mabl APIを使用するには、APIキーでAPIリクエストを認証する必要があります。

📘

APIキーの権限

APIキーの作成と管理は、ワークスペースのOwner(所有者) のみが行なえます。

APIキーの作成

mablアプリケーションでAPIキーを作成するには、[ワークスペース] > [API] で次の手順を実行します。

1. [+ APIキーの作成] ボタンをクリックします。
2. APIキーのタイプを選択します。

📘

APIキーのタイプ

mabl APIキーには、APIキーの種類に応じてさまざまな権限があります。mabl APIを操作するには、次の種類が使用できます。

• Command Line Interface (CLI) キー: 一般的な mabl APIの利用の場合
• Viewerキー: mabl API への読み取り専用アクセスの場合

3. APIキーの名前を指定します。
4. [保存] ボタンをクリックします。

APIキーの使用

APIリクエストを認証するには、[ワークスペース] > [API] でAPIキーをコピーして使用します。

mabl APIにAPIリクエストを送信するときは、ヘッダーの一部としてAPIキーを以下の形式で渡します。

• username: "key"
• password: "your-api-key"*

*"your-api-key" の部分には、[ワークスペース] > [APS] からコピーしたAPIキーを転記します。
以下のサンプルcURLコマンドは、APIリクエスト内でAPIキーを渡す方法を示しています。

curl -s "https://api.mabl.com/execution/result/event/DEPLOYMENT-EVENT-ID"\ 
     -u "key:YOUR-API-KEY"

インタラクティブAPIリファレンスページを使用している場合は、'Authentication' パネルに以下の情報を入力することで、APIリクエストを認証できます。

• [username] フィールドには、"key" という単語を入力します。
• [password] フィールドには、APIキーを入力します。

mablでAPIキーを管理する方法の詳細については、こちらをクリックしてください。

エンドポイントの概要

デプロイイベントAPI

デプロイメントイベントは、ワークスペース内のプランのうち、特定の条件 (環境、アプリケーション、プランラベルなど) に一致するすべてのプランの実行をトリガーします。デプロイメントイベントAPIには、2つのエンドポイントがあります。

• デプロイメントでのテストのトリガー (英語)
• デプロイメント結果のサマリーの取得 (英語)

デプロイメントイベントAPIを既存のCI/CDワークフローに組み込むと、コードが環境にデプロイされるとすぐに、その環境に関連付けられたすべてのプランを実行するように設定することができます。APIベースのCI/CDワークフローを実装する方法の詳細については、ドキュメントを参照してください。

レポーティングAPI

テスト結果やテスト実行成果物をエクスポートするには、レポーティングAPIエンドポイントを使用します。レポーティングAPIには、以下のようなエンドポイントがあります。

• テスト実行結果の取得
• プラン実行結果の取得
• テスト実行のバッチ結果取得
• テスト実成果物のエクスポートの準備
• テスト実行成果物のエクスポートの取得

レポーティングAPIエンドポイントは、以下のような場合に役に立ちます。

• テスト実行結果を社内データベースにエクスポートし、テスト頻度や成功率について時間経過に伴うトレンドを分析する。
• テスト実行結果を社内ダッシュボードにエクスポートし、チーム、リリース、ブランチごとにmablテストの結果の現在のステータスを表示する。
• 監査のために、テスト実行成果物を自動的にエクスポートする。

APIレスポンスタイプ

mablは、APIリクエストのステータスを標準的なHTTPレスポンスコードで示します。一般的に、以下のようなコードが使用されます。

• 2xx 番台のレスポンスコードは、成功を示します。
• 4xx 番台のレスポンスコードは、パラメーター値やAPIキーが不足しているなど、APIリクエストにエラーがあることを示します。
• 5xx 番台レスポンスコードは、mabl側に何らかのエラーがあることを示します。

4xx 番台のAPIレスポンスのトラブルシューティング

5xx 番台レスポンスのトラブルシューティング

5xx番台のレスポンはまれにしか発生しません。5xx番台のレスポンスを受け取った場合は、次の手順を実行します。

1. APIリクエストを再送信します。
2. mablステータスページ で、mablサービスのステータスを確認します。
3. それでも5xx番台のレスポンスが返され、かつmablステータスページに異状が表示されていない場合は、サポートまでお問い合わせください。

サンプル出力

mablヘルプページのAPIリファレンスを使用している場合、[EXAMPLES] をクリックすると、出力のJSONスキーマのサンプルが表示されます。

重要な概念

mablリソースID

アプリケーションや環境から、アドホック実行に至るまで、ワークスペースの全てのコンポーネントに mablリソースIDという、それぞれ固有のIDがあります。mablリソースIDは、mabl APIエンドポイントへのAPIリクエストのパラメーター値として使用されます。

日付フォーマットの標準

特に注釈がない限り、APIレスポンスで返される日付フィールドは、エポックミリ秒で表されます。