Co je rozhraní Jira REST API: Jak využít rozhraní REST API a zabezpečit klíč Jira API

Jira, univerzální platforma společnosti Atlassian pro sledování problémů a správu projektů, se stala nepostradatelným nástrojem pro nespočet vývojových týmů po celém světě. Její uživatelsky přívětivé rozhraní sice usnadňuje správu projektů a sledování problémů, ale skutečná síla systému Jira spočívá v jeho rozsáhlých možnostech přizpůsobení a integraci. Ústředním prvkem je rozhraní Jira REST API, které otevírá svět možností automatizace úloh, vytváření vlastních aplikací a bezproblémové integrace Jiry s dalšími nástroji ve vašem vývojovém ekosystému. V tomto obsáhlém průvodci se ponoříme do rozhraní Jira REST API, prozkoumáme jeho možnosti a projdeme si praktické příklady, které vám pomohou začít.

Klíčové poznatky: Jira REST API je univerzální nástroj pro automatizaci úloh, vytváření vlastních aplikací a integraci Jiry s dalšími vývojovými nástroji ve verzích Cloud i Server/Data Center. Nabízí širokou škálu funkcí včetně správy problémů, hromadných operací a vlastních sestav s podporou pokročilých funkcí, jako je stránkování a rozšiřování dat. I když mezi jednotlivými verzemi existují určité rozdíly, základní funkce rozhraní API zůstávají konzistentní, což týmům umožňuje efektivně přizpůsobit Jiru svým specifickým potřebám a hladce ji integrovat do svého vývojového ekosystému.

Co je rozhraní Jira API?

Rozhraní API (Application Programming Interface) je v podstatě soubor protokolů a nástrojů, které určují, jak mají softwarové komponenty vzájemně komunikovat. V kontextu systému Jira umožňuje rozhraní API externím aplikacím programově komunikovat se systémem Jira, což umožňuje získávat data a manipulovat s nimi a provádět akce v rámci systému Jira. Jira poskytuje dva typy rozhraní API:

Co je Java API

Rozhraní Jira Java API je výkonný nástroj pro vývojáře, kteří vytvářejí vlastní aplikace nebo zásuvné moduly Jira. Poskytuje přímý přístup k základním objektům a metodám Java serveru Jira, což umožňuje hlubokou integraci a přizpůsobení. Tato úroveň přístupu je však dostupná pouze pro lokální instalace systému Jira (server nebo datové centrum), kde máte přímý přístup k serveru. Pokud pracujete se službou Jira Cloud nebo vytváříte samostatnou integraci, je rozhraní REST API tou správnou cestou.

Co je rozhraní REST API

REST (Representational State Transfer) je architektonický styl, který definuje soubor omezení pro vytváření webových služeb. Rozhraní REST API vystavuje sadu koncových bodů HTTP, ke kterým lze přistupovat odesíláním požadavků pomocí specifických metod HTTP (GET, POST, PUT, DELETE) a provádět operace se zdroji.

Rozhraní Jira REST API se řídí touto architekturou a poskytuje komplexní sadu koncových bodů pro interakci s téměř všemi aspekty systému Jira, od problémů a projektů až po agilní nástěnky a ovládací panely. Vrací data ve formátu JSON a podporuje různé metody ověřování pro zajištění bezpečného přístupu.

Jednou z klíčových výhod rozhraní REST API je jeho nezávislost na platformě - rozhraní API můžete volat z jakéhokoli zařízení nebo aplikace, která umí zadávat požadavky HTTP, bez ohledu na použitý programovací jazyk. To z něj činí ideální volbu pro vytváření integrací mezi systémem Jira a jinými nástroji nebo pro skriptování interakcí se systémem Jira z příkazového řádku.

Co můžete dělat s rozhraním Jira REST API?

Možnosti jsou téměř nekonečné. Zde je jen několik příkladů toho, čeho můžete dosáhnout pomocí rozhraní Jira REST API:

• Automatizovat vytváření problémů: Integrujte Jiru se systémem sledování chyb nebo nástrojem zákaznické podpory a automaticky vytvářejte problémy v Jira, když dojde k určitým událostem, včetně všech relevantních podrobností.
• Synchronizace dat mezi systémy: Udržujte Jiru v synchronizaci s dalšími nástroji ve vývojovém řetězci, jako jsou systémy pro správu zdrojů, nástroje CI/CD nebo sady pro správu testů. Rozhraní API vám umožňuje promítat změny v systému Jira do jiných systémů a naopak.
• Hromadné operace: Potřebujete aktualizovat velký počet vydání najednou? Rozhraní REST API podporuje hromadné operace vytváření, aktualizace a mazání, což vám ušetří nespočet hodin ruční práce.
• Vlastní ovládací panely a sestavy: Získejte data z Jiry a použijte je k vytvoření vlastních ovládacích panelů, reportů nebo vizualizací dat přizpůsobených konkrétním potřebám vašeho týmu.
• Rozšíření funkcí systému Jira: Vytvářejte vlastní aplikace a integrace, které rozšiřují možnosti systému Jira, přidávají nové funkce nebo zefektivňují pracovní postupy specifické pro vaši organizaci.
• Migrace dat: Přechod z jiného systému pro sledování problémů do Jiry? Použijte rozhraní API k programovému importu stávajících dat do Jiry.
• Zálohování a archivace: Nastavte skripty pro pravidelné zálohování dat Jira nebo archivaci starých projektů a problémů.

To je jen několik příkladů - rozhraní Jira REST API poskytuje rozsáhlou sadu koncových bodů, které pokrývají téměř všechny funkce a vlastnosti dostupné v uživatelském rozhraní Jira. Pokud to umíte v aplikaci Jira, je pravděpodobné, že to umíte i prostřednictvím rozhraní API.

Hlavní rozdíly mezi rozhraním Jira Cloud REST API a rozhraním Data Center REST API

Přestože rozhraní Jira REST API poskytuje v podstatě stejné funkce pro Jira Cloud, Server a Datové centrum, je třeba si uvědomit několik zásadních rozdílů:

• Ověřování: Jira Cloud používá k ověřování OAuth 2.0 nebo tokeny API, které poskytují bezpečnou a na standardech založenou metodu pro udělování přístupu k rozhraní API. Datové centrum Jira naproti tomu používá především základní ověřování nebo soubory cookie relace.
• Verzování API: Rozhraní Jira Cloud REST API je verzované (v současné době verze 3), což společnosti Atlassian umožňuje časem rozhraní API vyvíjet a vylepšovat, aniž by došlo k narušení stávajících integrací. Datové centrum Jira však explicitní verzování nemá - rozhraní API je vázáno na konkrétní verzi aplikace Jira.
• Omezování rychlosti: Pro zajištění spravedlivého používání a zachování výkonu uplatňuje Jira Cloud přísnější omezení rychlosti pro požadavky API ve srovnání s datovým centrem. Integrace musí být navrženy s ohledem na tyto limity a musí implementovat vhodné omezování a zpracování chyb.
• Formát adresy URL: URL koncového bodu pro rozhraní REST API se mírně liší mezi cloudem a datovým centrem. Pro Jira Cloud je základní adresa URL ve formátu https://your-domain.atlassian.net/rest/api/3/, zatímco pro Data Center je to https://your-jira-instance.com/rest/api/latest/.

Navzdory těmto rozdílům zůstávají základní koncepty a způsoby použití rozhraní REST API v podstatě stejné v různých nasazeních. Dovednosti a znalosti, které získáte při práci s jednou verzí rozhraní API, budou snadno přenositelné na jiné verze.

Co potřebujete k práci s rozhraním Jira REST API?

Chcete-li začít používat rozhraní Jira REST API, budete potřebovat:

• Instance systému Jira: Může se jednat o lokalitu Jira Cloud nebo o samostatně hostovaný server Jira či instanci datového centra. K nastavení a správě integrací API budete potřebovat přístup správce.
• Ověřovací pověření: V závislosti na vašem nasazení Jiry to může být token OAuth 2.0, token API nebo základní autentizační údaje (uživatelské jméno a heslo).
• Klient API: K provádění požadavků HTTP na rozhraní API potřebujete klienta API. Může to být specializovaný nástroj pro testování API, jako je Postman, nástroj příkazového řádku, jako je cURL, nebo knihovna HTTP ve zvoleném programovacím jazyce (např. knihovna requests v jazyce Python nebo fetch API v jazyce JavaScript).
• Odkaz na dokumentaci rozhraní Jira API: Atlassian poskytuje rozsáhlou dokumentaci k rozhraní Jira REST API, která podrobně popisuje každý koncový bod, jeho parametry a příklady požadavků a odpovědí. Mějte ji při zkoumání rozhraní API vždy po ruce.

Po zavedení těchto prvků můžete začít zadávat první požadavky API.

Jak používat rozhraní Jira REST API 

Ukážeme si praktický příklad použití rozhraní Jira REST API k vytváření, načítání, aktualizaci a vyhledávání problémů. Pro naše příklady budeme používat Postman, ale principy platí pro jakéhokoli klienta API.

Krok 1: Vytvoření účtu Jira Cloud

Pokud ještě nemáte instanci Jira, se kterou byste mohli pracovat, nejjednodušší způsob, jak začít, je zaregistrovat se k bezplatné instanci Jira Cloud na adrese https://www.atlassian.com/software/jira. Jakmile je vaše stránka nastavena, vytvořte nový projekt, se kterým budete pracovat.

Krok 2: Vygenerování tokenu API Jira

K ověření našich požadavků API použijeme token API. Zde je návod, jak ho vygenerovat:

1. Přihlaste se ke svému účtu Atlassian a přejděte na stránku https://id.atlassian.com/manage-profile/security/api-tokens.
2. Klikněte na tlačítko "Vytvořit token API", přidejte tokenu popisný štítek a klikněte na tlačítko "Vytvořit".

1. Zkopírujte vygenerovaný token a bezpečně jej uložte. Po opuštění této stránky jej již nebudete moci zobrazit.

Krok 3: Zadejte první požadavek API pomocí nástroje Postman

Začněme načtením podrobností existujícího problému:

1. Otevřete aplikaci Postman a vytvořte nový požadavek.
2. Nastavte metodu HTTP na GET a zadejte adresu URL koncového bodu pro detail problému, přičemž doménu your-domain nahraďte doménou webu Jira a klíč ISSUE-KEY klíčem problému ve vašem projektu: https://your-domain.atlassian.net/rest/api/3/issue/ISSUE-KEY.
3. Na kartě "Autorizace" vyberte typ "Základní autorizace". Jako uživatelské jméno zadejte e-mailovou adresu svého účtu Atlassian a jako heslo vložte svůj token API.
4. Klikněte na tlačítko "Odeslat". Pokud je vše správně nastaveno, měla by se zobrazit odpověď JSON s úplnými podrobnostmi o zadaném problému, včetně jeho polí, komentářů, příloh a dalších údajů.

Krok 4: Vytvoření problému

Nyní vytvoříme novou záležitost prostřednictvím rozhraní API:

1. V aplikaci Postman změňte metodu HTTP na POST a aktualizujte adresu URL na koncový bod pro vytvoření vydání: https://your-domain.atlassian.net/rest/api/3/issue.
2. Na kartě Záhlaví přidejte novou dvojici klíč-hodnota: "Content-Type" a "application/json". Tím sdělíte systému Jira, že odesíláme užitečné zatížení JSON.

Přepněte na kartu "Body", vyberte přepínač "raw" a zadejte následující JSON, přičemž podle potřeby nahraďte hodnoty project.key, issuetype.name, summary a description:

 json

{
  "fields": {
    "project": {
      "key": "YOUR_PROJECT_KEY"
    },
    "issuetype": {
       "name": "Task"
    },
    "summary": "Issue created via REST API",
    "description": {
      "type": "doc",
      "version": 1,
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "This is a test issue created using the Jira REST API."
            }
          ]
        }
      ]
    }
  }
}

3. Klikněte na tlačítko "Odeslat". Jira vám odpoví se stavem 201 Vytvořeno a s úplnými podrobnostmi o nově vytvořeném problému.

Krok 5: Aktualizace vydání

Pro aktualizaci existujícího vydání použijeme metodu PUT:

1. Změňte metodu HTTP na PUT a aktualizujte adresu URL tak, aby ukazovala na vydání, které chcete aktualizovat: https://your-domain.atlassian.net/rest/api/3/issue/ISSUE-KEY.

V těle požadavku uveďte pole, která chcete aktualizovat, například:

 json

{
  "fields": {
    "summary": "Updated summary",
    "description": {
      "type": "doc",
      "version": 1,
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "This issue has been updated via the REST API."
            }
          ]
        }
      ]
    }
  }
}

2. Klikněte na tlačítko "Odeslat". Jira odpoví stavem 204 Žádný obsah, což znamená, že aktualizace proběhla úspěšně.

Krok 6: Vyhledávání problémů pomocí jazyka JQL

Výkonné možnosti vyhledávání v systému Jira jsou dostupné také prostřednictvím rozhraní REST API pomocí jazyka JQL (Jira Query Language):

1. Změňte metodu HTTP zpět na POST a aktualizujte adresu URL koncového bodu vyhledávání: https://your-domain.atlassian.net/rest/api/3/search.

V těle požadavku uveďte dotaz JQL a případné další parametry:

 json
Copy
{
  "jql": "project = YOUR_PROJECT_KEY AND status = 'To Do' ORDER BY created DESC",
  "fields": ["summary", "status", "assignee"],
  "maxResults": 10
}

 Tento dotaz vrátí 10 naposledy vytvořených záležitostí ve stavu "K vyřízení" ze zadaného projektu, včetně pouze polí souhrn, stav a příjemce.

2. Klikněte na tlačítko "Odeslat". Jira vám odpoví polem JSON s otázkami, které odpovídají vašim vyhledávacím kritériím.

Tyto příklady jen poodhalují možnosti rozhraní Jira REST API. Až se lépe seznámíte s dostupnými koncovými body a parametry, budete moci vytvářet stále složitější a výkonnější integrace.

Jak automatizovat vytváření a aktualizace problémů v aplikaci Jira pomocí Latenode

Jedním z nejvýkonnějších využití rozhraní Jira REST API je automatizace vytváření a aktualizace úloh. Pomocí webu Latenode, můžete nastavit sofistikované pracovní postupy, které automaticky vytvářejí a aktualizují úlohy v systému Jira na základě dat z externích zdrojů nebo specifických spouštěčů. Tím je zajištěno, že informace v systému pro správu projektů budou aktuální a včasné, což zvyšuje efektivitu týmu.

Můžete například vytvořit pracovní postup, který automaticky vytvoří novou úlohu v systému Jira, když obdržíte chybovou zprávu z monitorovacího systému, vyplní všechna potřebná pole a přiřadí úlohu příslušnému vývojáři. Jakmile přijdou aktualizace, může být úkol automaticky aktualizován, a jakmile je problém vyřešen, může být uzavřen. Tento zjednodušený přístup nejen zlepšuje sledování problémů, ale také šetří čas vašeho týmu, který se tak může soustředit na řešení problémů, nikoli na jejich správu.

Více informací o tomto skriptu a integraci s webem Latenode najdete v tomto článku. Integrace se stránkou Latenode nabízí několik klíčových výhod:

• Snadné používání Latenode zjednodušuje proces používání rozhraní API aplikace Jira, což usnadňuje automatizaci úkolů správy projektů i netechnickým uživatelům.
• Flexibilní ceny Uživatelé si mohou vybrat z různých plánů Latenode s různými náklady a funkcemi, které nejlépe vyhovují jejich potřebám.
• Komplexní řešení Latenode's integrací s Jira poskytuje přístup k široké škále funkcí pro správu projektů a sledování problémů.
• Přizpůsobení Uživatelé mohou přizpůsobit integrace Jira svým specifickým potřebám, což umožňuje automatizační řešení na míru v souladu s obchodními cíli.

Představte si, že se každý důležitý e-mail od klienta automaticky změní na úkol v systému Jira. S Latenode, se to stane skutečností. Naše platforma zajistí vytvoření nového úkolu ve správném projektu s vyplněnými poli na základě obsahu e-mailu, což zaručí, že žádný důležitý požadavek nebude opomenut.

Zde je příklad, jak pracovní postup Latenode automatizuje vytváření a aktualizace úloh Jira na základě příchozích e-mailových dat z externího zdroje.

Tento obrázek by zobrazoval vizuální reprezentaci pracovního postupu v rozhraní Latenode se spojenými uzly, které představují jednotlivé kroky procesu od přijetí e-mailu po vytvoření úlohy v systému Jira.

Toto je jen jeden z příkladů, jak Latenode může změnit váš přístup k používání rozhraní Jira API pomocí výkonné automatizace. Možnosti platformy jsou ve skutečnosti prakticky neomezené - můžete vytvářet libovolné automatizační scénáře potřebné ke zvýšení efektivity vašeho podnikání. Ať už se jedná o automatickou distribuci úkolů, zasílání oznámení, sledování klíčových ukazatelů výkonnosti nebo jakékoli jiné úkoly - Latenode poskytuje nástroje, které je uvedou v život.

S využitím vizuálního nástroje pro tvorbu pracovních postupů Latenode a bezproblémové integrace s rozhraním Jira REST API můžete snadno navrhovat a implementovat složité automatizační scénáře, čímž zvýšíte efektivitu řízení projektů a urychlíte pracovní postupy svého týmu.

Pokud potřebujete pomoc nebo radu, jak vytvořit vlastní skript, nebo pokud chcete tento skript zopakovat, obraťte se na naši komunitu Discord, kde jsou odborníci na automatizaci Low-code.

Stránkování, rozšiřování a řazení rozhraní Jira REST API

Jakmile začnete v aplikaci Jira pracovat s většími soubory dat, budete si muset uvědomit, jak rozhraní REST API pracuje se stránkováním, rozšiřováním vnořených zdrojů a řazením výsledků.

Rozšíření

Mnoho zdrojů Jira obsahuje odkazy na další vnořené zdroje. Například Issue obsahuje odkazy na svůj projekt, Issuetype, Creator, Reporter, Assignee, Comments, Attachments a další. Ve výchozím nastavení jsou tyto vnořené zdroje vráceny jako vnořené zdroje, které obsahují pouze několik základních polí a vlastní odkaz na celý zdroj.

Pokud potřebujete úplné údaje o vnořeném prostředku, můžete použít parametr expand query a požádat Jiru, aby do odpovědi zahrnula celý prostředek. Například pro zahrnutí úplných podrobností o projektu a příjemci problému:

GET .../rest/api/3/issue/ISSUE-KEY?expand=project,assignee

Více zdrojů můžete rozbalit tak, že je oddělíte čárkou. Uvědomte si, že rozšíření mohou výrazně zvětšit velikost užitečného zatížení odpovědi, proto je používejte s rozvahou.

Stránkování

Požadavky, které mohou potenciálně vrátit velké množství výsledků (například vyhledávání JQL), jsou ve výchozím nastavení stránkovány. Rozhraní API vrátí maximální počet výsledků na stránku (výchozí hodnota je 50, ale lze ji upravit až na 100) spolu s odkazy na další a předchozí stránky.

Stránkování můžete řídit pomocí parametrů startAt a maxResults:

• startAt: Index prvního výsledku, který se má vrátit (od 0)
• maxResults: Maximální počet výsledků, které se mají vrátit na stránku

Například pro načtení druhé stránky výsledků s velikostí stránky 20:

GET .../rest/api/3/search?jql=project=YOUR_PROJECT_KEY&startAt=20&maxResults=20

Vaše aplikace bude muset zvládnout více požadavků na načtení všech stránek s výsledky.

Objednávání

Pořadí výsledků můžete ovlivnit pomocí parametru orderBy, který přijímá seznam polí oddělených čárkou, podle kterých se mají seřadit. Každé pole může mít předponu -, která označuje sestupné pořadí.

Například seřadit záležitosti podle data vytvoření sestupně a poté podle priority vzestupně:

GET .../rest/api/3/search?jql=project=YOUR_PROJECT_KEY&orderBy=-created,priority

Ne všechna pole podporují řazení - informace o tom, co je k dispozici, naleznete v dokumentaci ke konkrétnímu koncovému bodu.

Příklady použití rozhraní Jira API

Zde je několik pokročilejších příkladů demonstrujících možnosti rozhraní Jira REST API pro hromadné operace.

Hromadné vytváření/aktualizace vydání z CSV

Předpokládejme, že máte soubor CSV obsahující data pro více problémů, které chcete v systému Jira vytvořit nebo aktualizovat. K automatizaci tohoto procesu můžete použít nástroj, jako je Postman:

1. V aplikaci Postman vytvořte nový požadavek na koncový bod pro vytvoření nebo aktualizaci problému.

Na kartě Tělo vyberte přepínač "raw" a zadejte šablonu pro data vydání pomocí proměnných pro pole, která budou pocházet z vašeho CSV:

{
  "fields": {
    "project": {"key": "{{project_key}}"},
    "issuetype": {"name": "{{issue_type}}"},
    "summary": "{{summary}}",
    "description": {
      "type": "doc",
      "version": 1,
      "content": [
        {
          "type": "paragraph",
          "content": [
            {
              "type": "text",
              "text": "{{description}}"
            }
          ]
        }
      ]
    },
    "assignee": {"name": "{{assignee}}"},
    "priority": {"name": "{{priority}}"}
  }
}

2. Přepněte na kartu "Pre-request Script" a přidejte kód pro načtení souboru CSV a nastavení příslušných proměnných:

const csvFile = pm.iterationData.readCSV();
pm.variables.set('project_key', csvFile[0]);
pm.variables.set('issue_type', csvFile[1]);
pm.variables.set('summary', csvFile[2]);
pm.variables.set('description', csvFile[3]);
pm.variables.set('assignee', csvFile[4]);
pm.variables.set('priority', csvFile[5]);

3. V okně "Runner" vyberte soubor CSV jako datový soubor a spusťte běh. Postman vytvoří nový požadavek pro každý řádek ve vašem CSV a nahradí jej proměnnými ze souboru.

Jedná se o výkonnou techniku pro hromadný import dat do systému Jira z externích zdrojů.

Hromadné vytváření/aktualizace vydání z JSON

Pokud jsou vaše zdrojová data již ve formátu JSON, můžete použít koncový bod pro hromadné vytvoření/aktualizaci a zpracovat více čísel v jednom požadavku:

POST https://your-domain.atlassian.net/rest/api/3/issue/bulk

Tělo požadavku by mělo obsahovat pole objektů pro vytvoření/aktualizaci vydání, přičemž každý z nich má stejný formát jako jeden požadavek na vytvoření/aktualizaci vydání:

{
  "issueUpdates": [
    {
      "fields": {
        "project": {"key": "PROJ1"},
        "issuetype": {"name": "Task"},
        "summary": "Issue 1",
        "description": {
          "type": "doc",
          "version": 1,
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": "First issue created via bulk update"
                }
              ]
            }
          ]
        }
      }
    },
    {
      "fields": {
        "project": {"key": "PROJ2"},
        "issuetype": {"name": "Bug"},
        "summary": "Issue 2",
        "description": {
          "type": "doc",
          "version": 1,
          "content": [
            {
              "type": "paragraph",
              "content": [
                {
                  "type": "text",
                  "text": "Second issue created via bulk update"
                }
              ]
            }
          ]
        },
        "priority": {"name": "High"},
        "labels": ["bulk-import", "api-test"]
      }
    }
  ]
}

Tím se v jednom požadavku vytvoří dva problémy - úkol v projektu PROJ1 a chyba v projektu PROJ2. Do jednoho hromadného požadavku můžete zahrnout až 50 problémů.

Hromadný koncový bod je také užitečný pro provádění hromadných přechodů, aktualizací a mazání. Například k přechodu více záležitostí do stavu "Hotovo":

{
  "transition": {
    "id": "31"
  },
  "issues": [
    {"key": "ISSUE-1"},
    {"key": "ISSUE-2"},
    {"key": "ISSUE-3"}
  ]
}

To předpokládá, že "31" je ID vašeho přechodu "Hotovo" - dostupné přechody pro daný typ problému můžete najít prostřednictvím koncového bodu /rest/api/3/issue/{issueIdOrKey}/transitions.

Souhrn

Rozhraní Jira REST API je nesmírně výkonný nástroj pro integraci Jiry s jinými systémy, automatizaci úloh a rozšiřování možností Jiry. V této příručce jsme se věnovali základům rozhraní API, včetně:

• Rozdíl mezi rozhraními API Java a REST a kdy je použít.
• Hlavní rozdíly mezi rozhraními API pro cloud a server/datové centrum
• Jak se ověřit k rozhraní API pomocí tokenů API nebo funkce Basic Auth
• Vytváření prvních požadavků API pomocí aplikace Postman
• Vytváření, vyhledávání, aktualizace a vyhledávání otázek
• Zpracování stránkování, rozšiřování a řazení výsledků
• Pokročilé případy použití, jako je hromadné vytváření/aktualizace z dat CSV a JSON

Zatím jsme však jen poškrábali povrch. Rozhraní Jira REST API poskytuje koncové body pro práci s téměř všemi aspekty systému Jira, od projektů a nástěnek až po uživatele a oprávnění. Při vytváření svých integrací nezapomeňte nahlédnout do oficiální dokumentace společnosti Atlassian, kde najdete nejaktuálnější a nejobsáhlejší informace.

S rozhraním Jira REST API v sadě nástrojů máte téměř nekonečné možnosti, co můžete s Jirou dělat. Ať už vytváříte vlastní přehledový panel, synchronizujete data s jiným systémem nebo automatizujete složité pracovní postupy, rozhraní API vám k tomu poskytne potřebnou flexibilitu a výkon.

ČASTO KLADENÉ DOTAZY

Jaké metody ověřování podporuje rozhraní Jira REST API?

Jira Cloud podporuje OAuth 2.0 a tokeny API pro ověřování. V případě OAuth je třeba zaregistrovat aplikaci ve vývojářské konzoli Atlassian a získat ID a tajný kód klienta. Tokeny API jsou jednodušší možností pro skripty a osobní integrace. Jira Server a Data Center podporují základní ověřování (uživatelské jméno a heslo) a ověřování na základě relace pomocí souborů cookie.

Liší se rozhraní Jira REST API mezi Jira Cloud a Jira Data Center?

I když jsou základní koncové body a funkce z velké části stejné, existují některé klíčové rozdíly:

• Základní adresa URL rozhraní API se liší - Cloud používá adresu https://your-domain.atlassian.net/rest/api/3/, zatímco Server/Datové centrum používá adresu https://your-jira-instance.com/rest/api/latest/.
• Cloud uplatňuje přísnější limity rychlosti a vyžaduje ověřování pro všechny požadavky, zatímco server/datové centrum má mírnější výchozí nastavení.
• U některých pokročilých funkcí, jako jsou rozhraní API Agile a Service Desk, se liší dostupné koncové body a formáty požadavků a odpovědí mezi cloudem a serverem/datovým centrem.

Vždy se podívejte do dokumentace k nasazení aplikace Jira, abyste se ujistili, že používáte správné adresy URL a parametry.

Jak řešit omezování rychlosti API?

Služba Jira Cloud vynucuje omezení rychlosti, aby byla zajištěna stabilita a výkon služby. Pokud limit rychlosti překročíte, obdržíte odpověď 429 Too Many Requests.

Abyste se vyhnuli překročení limitů rychlosti:

• Pokud je to možné, ukládejte data do mezipaměti, abyste se vyhnuli opakovaným požadavkům.
• K načtení velkých sad výsledků pomocí více požadavků použijte stránkování, místo abyste se snažili načíst vše najednou.
• Implementujte do kódu klienta exponenciální zpětný výběr, abyste postupně zvyšovali prodlevu mezi opakovanými pokusy, když dojde k překročení limitu rychlosti.
• Pokud oprávněně potřebujete vyšší limit, obraťte se na podporu společnosti Atlassian a prodiskutujte své možnosti.

Nasazení serverů a datových center mají ve výchozím nastavení omezení rychlosti zakázáno, ale správci mohou v případě potřeby povolit a nakonfigurovat omezení rychlosti.

Mohu použít rozhraní Jira REST API pro server/datové centrum?

Ano, Jira Server a Data Center mají rozhraní REST API, které je do značné míry podobné rozhraní API služby jira Cloud. Hlavní rozdíly jsou následující:

• Základní adresa URL používá /rest/api/latest/ místo /rest/api/3/.
• Některé koncové body mohou mít mírně odlišné parametry nebo formáty odpovědí.
• Ověřování se obvykle provádí pomocí funkce Basic Auth nebo souborů cookie relace, nikoli pomocí OAuth nebo tokenů API.

Nejpřesnější informace pro vaši verzi aplikace Jira naleznete v dokumentaci rest api pro konkrétní server/datové centrum.

Rozhraní Jira REST API představuje výkonný a flexibilní způsob integrace aplikace Jira do pracovního postupu vývoje. Ať už pracujete v cloudu nebo spravujete vlastní server, rozhraní API poskytuje nástroje, které potřebujete k automatizaci, přizpůsobení a rozšíření systému Jira tak, aby vyhovoval jedinečným potřebám vašeho týmu. Po troše zkoumání a experimentování budete moci plně odemknout potenciál systému Jira a posunout správu projektů na vyšší úroveň.