API
API umożliwia programowe uruchamianie eksportu — w przypadku integracji i niestandardowych przepływów pracy. Jest częścią aplikacji Exportelier Automation.
Uwierzytelnianie
Połączenia są uwierzytelniane za pomocą tokena okaziciela generowanego w Ustawienia → REST API tokeny w aplikacji Automatyzacja. Każdy token jest powiązany z dokładnie jednym harmonogramem: mówi żądanie uruchom to, nigdy uruchom to zapytanie.
Kompletny token jest pokazywany jednorazowo, podczas jego generowania lub rotacji. Tylko skrót jest przechowywany, więc nie można go później odzyskać – w tym momencie skopiuj go do swojej integracji.
Ważność i rotacja
Każdy token wydawany jest z ważnością 30, 90, 180 lub 365 dni (domyślnie 90) oraz przestaje działać po jego wygaśnięciu. Nie ma nieograniczonej opcji: te referencje są żywe buduj potoki i konta integracyjne poza Jira, gdzie nic ich nie wygaśnie.
Rotate wystawia nowy sekret dla istniejącego tokena, zachowując jego nazwę i powiązanie harmonogram i historię jego aktywności. Poprzedni sekret natychmiast przestaje działać – tam nie ma nakładającego się okna — więc zaktualizuj system wywołujący, wprowadzając tę samą zmianę. Obracanie również rozpoczyna ponownie okres ważności.
Tokeny utworzone przed okresem ważności nadal działają i są oznaczone jako * „Bez wygaśnięcia — rotacja ten token”*. Obróć jeden, aby objąć go bieżącymi zasadami.
Co zwraca punkt końcowy
Nieznany, unieważniony, wygasły lub błędnie wpisany token zwraca ten sam 401 z
{"error":"unauthorized"}. Jest to celowe: odpowiedź nie może informować dzwoniącego
czy dany token istnieje.
| Status | Treść | Znaczenie |
|---|---|---|
202 | {"jobId":…,"status":"queued"} | Eksport został umieszczony w kolejce. |
200 | {"jobId":…,"status":"queued"} | Powtórka wcześniejszego żądania z tym samym Idempotency-Key. |
401 | {"error":"unauthorized"} | Token nieznany, unieważniony, wygasł lub klucz tajny jest błędny. |
403 | {"error":"forbidden"} | Subskrypcja Automation nie jest aktywna. |
404 / 409 | {"error":"schedule_not_found"} / {"error":"schedule_disabled"} | Powiązany harmonogram zniknął lub został wstrzymany. |
429 | {"error":"rate_limited"} | Osiągnięto limit prędkości — patrz Odniesienie do limitów. |
Przeglądanie aktywności tokena
Rozwinięcie tokenu na liście pokazuje jego ostatnio wywołane eksporty wraz z identyfikatorami zadań i jak często ktoś przedstawiał do tego zły sekret. Rosnąca liczba niepowodzeń na tokenie którego nie używasz aktywnie, jest powodem, aby go obrócić.
REST API zarządzanie tokenami z nazwą tokena i powiązanym selektorem harmonogramu.
Typowy przepływ
- Uwierzytelnij.
- Poproś o eksport (kontekst, szablon, format).
- Sprawdź status zadania dla dużych eksportów.
- Pobierz wynik.
Limity stawek
API podlega limitom szybkości — patrz Odniesienie do limitów. W przypadku dostarczania sterowanego zdarzeniami zamiast odpytywania należy rozważyć webhooks.
Ścieżki punktów końcowych oraz schematy żądań/odpowiedzi są udokumentowane w produkcie i zostaną tutaj rozwinięte. Na tej stronie opisano model i przepływ.