始める前に
必要なもの
- ワークスペースの Connections モジュール：Team、Business、Partner、Enterprise プランに含まれ、Project プランではアドオン 1 回の UAT 向け連携として利用できます。
- UAT Studio プロジェクトの管理者権限。
- Make アカウント。無料プランで使えます。
設定 · プロジェクトごとに 1 回
UAT Studio を Make に接続する
1
UAT Studio で API キーを作成する
- app.uat.studio にサインインし、プロジェクトを開いて Setup に進みます。
- API keys カードで Make などの名前を入力し、Create API key をクリックします。
- Copy をクリックします。UAT Studio はキーを一度しか表示しないので、貼り付けるまでウィンドウは開いたままにしてください。
2
シナリオに HTTP モジュールを追加する
- Make で Create a new scenario をクリックし、大きな + をクリックします。
- HTTP を検索し、Make a request を選びます。
Make 用 UAT Studio アプリを準備中ですそれまでは HTTP モジュールで同じことができます。アプリが公開されたら、代わりに UAT Studio を選び、同じ API キーを貼り付けてください。
3
リクエストを入力する
Make a request の項目を上から順に入力します。表にない項目はそのままにしてください。
| 項目 | 入力内容 |
|---|---|
| Authentication type | No authentication。キーは下のヘッダーに入れます。 |
| URL | https://app.uat.studio/api/v1/issues?order=created、または下の表にある別のアドレス。 |
| Method | 読み取りは GET、作成は POST、変更は PATCH。 |
| Headers | Add a header をクリックします。Name：Authorization。Value：Bearer、半角スペース、API キー。 |
| Query parameters | 空欄のままにします。 |
| Body content type | 読み取り（GET）：空欄のまま。作成・変更：application/json。 |
| Body input method | 作成・変更の場合のみ：JSON string。 |
| Body content | 作成・変更の場合のみ：JSON 形式の項目（例：{"title": "Save fails", "severity": "High"}）。 |
| Parse response | Yes。次のモジュールで課題のフィールドを使えるようになります。 |
| Pagination type | 空欄のままにします。 |
Save をクリックします。
4
実行してスケジュールを設定する
- Run once をクリックします。出力にプロジェクトの課題が表示されます。
- 次のモジュールを追加します。課題の一覧に対する Iterator、Filter（例：重大度が Critical）、そして Slack や Google Sheets など処理を行うアプリです。
- 新しい課題だけを処理するには、前回の実行時刻を指定した
&since=を追加するか、Make の Data store を使って処理済みのキーを記録します。 - スケジュール（例：15 分ごと）を設定し、シナリオをオンにします。
使える機能 · https://app.uat.studio/api/v1
API のアドレス
| 種類 | リクエスト | 内容 |
|---|---|---|
| 読み取り | GET /issues?order=created | 最新の課題。order=updated：最近変更されたもの。since、status、limit（最大 100）も指定できます。 |
| 読み取り | GET /issues/ISS-012 | 1 件の課題。 |
| 読み取り | GET /signoffs | サインオフ（新しい順）。 |
| 作成 | POST /issues | 新しい課題：title。任意で description、severity、priority、test_number、step_number、assignee。 |
| 変更 | PATCH /issues/ISS-012 | status、severity、assignee。任意で comment。 |
| 変更 | POST /issues/ISS-012/comments | 履歴への comment。 |
| 作成 | POST /testers | テスター：name。任意で email と group。 |
各課題には、キー（ISS-012）、タイトル、説明、重大度、優先度、ステータス、担当者、テスト、発見したテスター、Jira または Azure DevOps のチケット、UAT Studio へのリンクが含まれます。
活用アイデア
チームでの活用例
- 重大度でフィルターをかけ、Critical の課題ごとにメッセージをチャットチャンネルへ送信。
- すべてのサインオフをスプレッドシートやプロジェクトポートフォリオツールに記録し、どの UAT が承認されたかをステアリングコミッティが把握。
- フォームや人事システムからテスターを追加：新しい行が、適切なグループのテスターになります。
- サポートツールから課題を作成：タグ付きのチケットが、テストにリンクされた UAT の課題になります。
うまくいかないとき
よくあるメッセージ
| メッセージ | 対処方法 |
|---|---|
| The API key is not valid | キーが取り消されたか、入力が間違っています。Setup › API keys で新しいキーを作成し、接続し直してください。 |
| Connections … are not part of the plan | ワークスペースに Connections モジュールがありません。Plan & billing で追加してください。 |
| This workspace is read-only | プランが終了しています。読み取りはできますが、作成や変更はできません。 |
| There is no issue ISS-… | キーが別のプロジェクトのものであるか、課題が統合されています。API キーと課題キーを確認してください。 |
| 新しい課題を登録しても何も起きない | シナリオはスケジュールに従って実行されます。シナリオがオンになっているか、キーが正しいプロジェクトのものかを確認してください。 |
セキュリティ
キーを安全に保つしくみ
- キーでアクセスできるのは1 つのプロジェクトだけで、ワークスペースのそれ以外には一切アクセスできません。
- UAT Studio が保存するのはキーのフィンガープリントだけで、キーそのものは保存しません。Setup には末尾 4 文字と最終使用日時が表示されます。
- Setup の Revoke で、キーをすぐに無効にできます。
- キーを使って作成・変更された課題やテスターは、キーの名前とともに課題の履歴と監査ログに記録されます。
- キーをメール、チャット、コードに含めないでください。貼り付けるのは Make だけにしてください。