Łączenie Jira za pomocą tokena API

Token API umożliwia Planning Poker Web odczytywanie zgłoszeń Jira i zapisywanie w nich zaakceptowanej estymaty bez przechodzenia przez ekran logowania. Ta strona wyjaśnia, jak utworzyć token, jakie działania umożliwia i co sprawdzić w razie problemów. Dotyczy Jira Cloud (adresu takiego jak twoj-zespol.atlassian.net). Jira Data Center nie jest obsługiwana.

Zanim zaczniesz

Potrzebujesz uprawnienia do zarządzania planning poker w organizacji. Właściciele mają je domyślnie.
Konto Jira powiązane z tokenem musi mieć w każdym używanym projekcie uprawnienia do przeglądania projektu (import zgłoszeń) i edytowania zgłoszeń (zapis estymaty). Jeśli tylko importujesz zadania i nie odsyłasz estymat, wystarczy przeglądanie.
Najlepiej użyć wspólnego konta przeznaczonego do tego celu, na przykład [email protected], zamiast konta konkretnej osoby. Estymata pojawi się w historii zgłoszenia pod nazwą tego konta, a osobisty token przestanie działać, gdy jego właściciel odejdzie z firmy lub straci dostęp.

Krok 1: utwórz token w Atlassian

Zaloguj się do Atlassian na wybranym koncie i otwórz id.atlassian.com → Bezpieczeństwo → Tokeny API.
Wybierz Utwórz token API. Wybierz zwykły token, nie opcję „Utwórz token API z zakresami” — tokeny z zakresami nie działają z tym połączeniem.
Nadaj mu rozpoznawalną nazwę, na przykład „Planning Poker Web”, i wybierz okres ważności.
Od razu skopiuj token. Atlassian wyświetla go tylko raz. Jeśli go zgubisz, utwórz nowy.

Jeśli nie widzisz tej opcji, administrator Atlassian mógł ograniczyć możliwość tworzenia tokenów. Poproś o jej włączenie dla wybranego konta.

Krok 2: połącz token w Planning Poker Web

Otwórz Ustawienia → Integracje, wybierz Jira, następnie Połącz i wybierz opcję Token API.
Wypełnij trzy pola:
- Witryna Jira: adres Jira, na przykład https://twoj-zespol.atlassian.net. Akceptowane są wyłącznie adresy https://….atlassian.net.
- Adres e-mail konta: adres e-mail konta Atlassian, które utworzyło token.
- Token API: skopiowany token.
Wybierz Testuj. Jeśli połączenie działa, zobaczysz nazwę konta Jira. Token jest przechowywany w postaci zaszyfrowanej i nie zostanie ponownie wyświetlony.
W kroku Konfiguracja wybierz, czy estymaty mają być odsyłane do Jira i do którego pola. Zobacz Odsyłanie estymat.

Jak to działa

Każde żądanie jest wysyłane z naszych serwerów do Jira i podpisywane adresem e-mail oraz tokenem. Token ma takie same uprawnienia jak konto, które go utworzyło — ani większe, ani mniejsze. Planning Poker Web wykonuje tylko następujące czynności:

Odczytuje projekty, a w obrębie projektu statusy, typy zgłoszeń, epiki i sprinty, aby udostępnić filtry podczas importu.
Odczytuje zgłoszenia: klucz, tytuł i opis, aby dodać je do pokoju.
Zapisuje jedną liczbę w jednym zgłoszeniu: zaakceptowaną estymatę w wybranym polu.

Nigdy nie tworzy ani nie usuwa zgłoszeń, nie zmienia ich statusu i nie dodaje komentarzy. Sprinty są odczytywane tylko wtedy, gdy konto może otworzyć tablicę projektu w Jira Software. W przeciwnym razie filtr sprintów będzie pusty.

Jeśli połączenie nie działa

„Jira odrzuciła dane logowania”: adres e-mail lub token jest błędny, token został unieważniony albo wygasł. Utwórz nowy token i wybierz Połącz ponownie.
„Jira odmówiła dostępu (403)”: Jira rozpoznała klucz, ale odrzuciła żądanie. Sprawdź kolejno, czy konto ma dostęp do Jira na tej witrynie, może przeglądać projekt (i edytować zgłoszenia, jeśli wysyłasz estymaty), administrator Atlassian nie ograniczył dostępu do API do wybranych sieci oraz czy token jest zwykłym tokenem, a nie tokenem „z zakresami”. Szczegółowe wyjaśnienie Jira pojawi się po dwukropku, jeśli zostanie zwrócone.
Projektu nie ma na liście: konto nie może go przeglądać. Dodaj konto do projektu lub użyj konta, które już ma do niego dostęp.
Estymata nie została wysłana, bo pola nie ma na ekranie: pole musi znajdować się na ekranie edycji zgłoszenia w tym projekcie. Jira ma dwa podobne pola: Story points i Story point estimate. Wybierz to, które wyświetla Twoja tablica.
„Użyj adresu Jira Cloud”: adres witryny musi mieć format https://twoj-zespol.atlassian.net, bez dodatkowej ścieżki.

Wygaśnięcie tokena lub rozłączenie

Tokeny Atlassian mają ograniczony czas ważności. Gdy token wygaśnie, utwórz nowy i wybierz Połącz ponownie; ustawienia estymat zostaną zachowane. Aby zakończyć połączenie, wybierz Rozłącz w Planning Poker Web i, jeśli chcesz, unieważnij token w id.atlassian.com → Bezpieczeństwo → Tokeny API. Potem nic nie będzie mogło uzyskać dostępu do Jira.

Poprzednia Łączenie i importowanie zadań Następna Odsyłanie estymat