Stacking
PL/EN
Kontakt
ksef2
GitHub

Zarządzaj tokenami

Generuj, listuj, sprawdzaj i cofaj tokeny KSeF przez ksef2.

Edytuj tę stronęv0.22.2 · b4b3eb9
Na tej stronie

Użyj auth.tokens, gdy uwierzytelniony kontekst ma tworzyć albo wycofywać tokeny KSeF dla automatyzacji. Przykłady zakładają, że masz już uwierzytelnionego klienta auth.

Wygeneruj token

Wybierz najmniejszy zestaw uprawnień wymagany przez automatyzację, która będzie używać tokena.

token = auth.tokens.generate(
    permissions=["invoice_read"],
    description="nightly invoice export",
)

token_reference = token.reference_number
token_secret = token.token
python

generate() zwraca uchwyt GeneratedToken, gdy tylko KSeF udostępni jednorazową wartość credentiala. Jego pole token jest sekretem, którego automatyzacja użyje później do uwierzytelniania tokenem; uchwyt udostępnia każde pole odpowiedzi generowania.

Domyślny repr i ogólne zrzuty Pydantic pomijają sekret. Odczytuj .token tylko na granicy chronionego magazynu albo użyj to_sensitive_dict(), gdy potrzebujesz jawnej mapy zawierającej sekret.

Po zapisaniu credentiala poczekaj jawnie, gdy następna operacja wymaga już aktywnego tokena:

status = auth.tokens.generate(...).wait(timeout=60.0, poll_interval=1.0)
# albo na uchwycie, który już masz:
status = token.wait(timeout=60.0, poll_interval=1.0)
python

Timeout albo błąd transportu z wait() nie odrzuca zapisanego wcześniej credentiala. Wznów sprawdzanie później przez auth.tokens.get_status(reference_number=...).

Listuj tokeny

list() zwraca Pager: iteruj po nim, by dostać każdy token, wywołaj .pages() dla list wielkości strony albo .first_page(), by wykonać jedno żądanie. Nic nie jest pobierane, dopóki go nie zużyjesz.

Wszystkie tokeny

for item in auth.tokens.list():
    print(item.reference_number, item.status, item.description)

# TokenInfo
# {
#   "reference_number": "20260625-TOKEN-...",
#   "description": "nightly invoice export",
#   "requested_permissions": ["invoice_read"],
#   "status": "active"
# }
python

Jedna strona

first = auth.tokens.list().first_page()
python

Strona po stronie

for page in auth.tokens.list().pages():
    print(len(page), "tokens on this page")
python

Sprawdź albo cofnij jeden token

Do późniejszych operacji cyklu życia użyj numeru referencyjnego tokena.

status = auth.tokens.get_status(reference_number="20260625-TOKEN-...")

# TokenStatusResponse
# {
#   "reference_number": "20260625-TOKEN-...",
#   "status": "active"
# }
python
auth.tokens.revoke(reference_number="20260625-TOKEN-...")
python

Zalecany przepływ

  1. Wybierz najmniejszy zestaw uprawnień wymagany przez automatyzację.

  2. Wygeneruj token w uwierzytelnionym kontekście, który ma być jego właścicielem.

  3. Zapisz wartość tokena w magazynie sekretów, a numer referencyjny w metadanych.

  4. Poczekaj na aktywację, gdy token musi być od razu gotowy do użycia.

  5. Listuj albo sprawdzaj referencje tokenów podczas audytów.

  6. Cofaj tokeny nieużywane, wygasłe albo naruszone.

Następne przepływy