Zanim Państwo zaczną
Co będzie potrzebne
- Moduł Connections w przestrzeni roboczej: jest dostępny w planach Team, Business, Partner i Enterprise, a w planie Project jako dodatek Integracje dla jednego UAT.
- Uprawnienia administratora w projekcie UAT Studio.
- Konto Make. Bezpłatny plan wystarczy.
Konfiguracja · raz na projekt
Połączenie UAT Studio z Make
1
Utworzenie klucza API w UAT Studio
- Zalogować się na app.uat.studio, otworzyć projekt i przejść do Setup.
- Na karcie API keys wpisać nazwę, np. Make, i kliknąć Create API key.
- Kliknąć Copy. UAT Studio pokazuje klucz tylko raz; okno należy zostawić otwarte do jego wklejenia.
2
Dodanie modułu HTTP do scenariusza
- W Make kliknąć Create a new scenario, a potem duży +.
- Wyszukać HTTP i wybrać Make a request.
Aplikacja UAT Studio dla Make jest w przygotowaniuDo tego czasu to samo robi moduł HTTP. Gdy aplikacja będzie dostępna, wystarczy wybrać UAT Studio i wkleić ten sam klucz API.
3
Uzupełnienie żądania
Uzupełnić pola Make a request od góry do dołu. Pola, których nie ma w tabeli, zostawić bez zmian.
| Pole | Co wpisać |
|---|---|
| Authentication type | No authentication. Klucz trafia do nagłówka poniżej. |
| URL | https://app.uat.studio/api/v1/issues?order=created lub inny adres z tabeli poniżej. |
| Method | GET do odczytu, POST do tworzenia, PATCH do zmiany. |
| Headers | Kliknąć Add a header. Name: Authorization. Value: Bearer, spacja i klucz API. |
| Query parameters | Zostawić puste. |
| Body content type | Do odczytu (GET): zostawić puste. Do tworzenia lub zmiany: application/json. |
| Body input method | Tylko do tworzenia lub zmiany: JSON string. |
| Body content | Tylko do tworzenia lub zmiany: pola jako JSON, np. {"title": "Save fails", "severity": "High"}. |
| Parse response | Yes, aby kolejne moduły mogły korzystać z pól zgłoszeń. |
| Pagination type | Zostawić puste. |
Kliknąć Save.
4
Uruchomienie i ustawienie harmonogramu
- Kliknąć Run once. Wynik pokazuje zgłoszenia projektu.
- Dodać kolejne moduły: Iterator na liście zgłoszeń, Filter (np. waga Critical) i aplikację, która ma działać, np. Slack lub Google Sheets.
- Aby działać tylko na nowych zgłoszeniach, należy dodać
&since=z czasem poprzedniego uruchomienia lub użyć Data store w Make do zapamiętania obsłużonych kluczy. - Ustawić harmonogram (np. co 15 minut) i włączyć scenariusz.
Co można wykorzystać · https://app.uat.studio/api/v1
Adresy API
| Rodzaj | Żądanie | Co robi |
|---|---|---|
| Odczyt | GET /issues?order=created | Najnowsze zgłoszenia. order=updated: ostatnio zmienione. Ponadto since, status i limit (do 100). |
| Odczyt | GET /issues/ISS-012 | Jedno zgłoszenie. |
| Odczyt | GET /signoffs | Sign-offy, od najnowszych. |
| Tworzenie | POST /issues | Nowe zgłoszenie: title i opcjonalnie description, severity, priority, test_number, step_number, assignee. |
| Zmiana | PATCH /issues/ISS-012 | status, severity lub assignee, z opcjonalnym comment. |
| Zmiana | POST /issues/ISS-012/comments | comment w historii. |
| Tworzenie | POST /testers | Tester: name i opcjonalnie email oraz group. |
Każde zgłoszenie zawiera klucz (ISS-012), tytuł, opis, wagę, priorytet, status, osobę przypisaną, test i testera, który je znalazł, ticket w Jira lub Azure DevOps oraz link do UAT Studio.
Pomysły
Co budują z tym zespoły
- Wiadomość dla każdego zgłoszenia Critical na kanale czatu, z filtrem wagi.
- Każdy sign-off w arkuszu kalkulacyjnym lub narzędziu do zarządzania portfelem projektów, aby komitet sterujący widział, które UAT zostały zaakceptowane.
- Testerzy z formularza lub systemu HR: nowy wiersz staje się testerem we właściwej grupie.
- Zgłoszenia z narzędzia wsparcia: ticket z tagiem staje się zgłoszeniem w UAT, powiązanym z testem.
Gdy coś pójdzie nie tak
Częste komunikaty
| Komunikat | Co zrobić |
|---|---|
| The API key is not valid | Klucz został unieważniony lub błędnie wpisany. Należy utworzyć nowy klucz w Setup › API keys i połączyć się ponownie. |
| Connections … are not part of the plan | Przestrzeń robocza nie ma modułu Connections. Można go dodać w Plan & billing. |
| This workspace is read-only | Plan się zakończył. Odczyt nadal działa; tworzenie i zmiany nie. |
| There is no issue ISS-… | Klucz należy do innego projektu lub zgłoszenie zostało scalone. Należy sprawdzić klucz API i klucz zgłoszenia. |
| Po nowym zgłoszeniu nic się nie dzieje | Scenariusz działa według harmonogramu. Należy sprawdzić, czy jest włączony i czy klucz należy do właściwego projektu. |
Bezpieczeństwo
Jak chroniony jest klucz
- Klucz daje dostęp do jednego projektu i do niczego więcej w przestrzeni roboczej.
- UAT Studio przechowuje tylko odcisk klucza, nigdy sam klucz. Setup pokazuje cztery ostatnie znaki i datę ostatniego użycia.
- Revoke w Setup natychmiast wyłącza klucz.
- Każde zgłoszenie lub tester utworzony bądź zmieniony za pomocą klucza jest widoczny w historii zgłoszenia i dzienniku audytu, z nazwą klucza.
- Klucza nigdy nie należy umieszczać w e-mailu, na czacie ani w kodzie; należy wklejać go wyłącznie w Make.