Přeskočit obsah

Klientské aplikace

Hlavní nabídka Nastavení Klientské aplikace

Klientská aplikace vám umožňuje vytvořit neuživatelský účet, který slouží pro programatický přístup k API Alice. Každá klientská aplikace má vlastní přihlašovací údaje (Client ID a Client Secret) a je propojená s virtuálním uživatelským účtem, který určuje oprávnění a přístup k účetním jednotkám.

Klientské aplikace se typicky využívají pro:

  • Automatické nahrávání dokumentů z externího systému
  • Integrace s Power Automate nebo jinými automatizačními nástroji
  • Propojení s vlastní aplikací přes API
  • Autentizaci webhooků pro bezpečné zpracování událostí
  • Stahování a export dokumentů přes API
  • Redque můstek (automatický přenos do účetních systémů)

Důležité upozornění

Správa klientských aplikací vyžaduje oprávnění Administrátora.

Vytvoření klientské aplikace

Klientská aplikace pro Redque můstek

V návodu níže uvidíte, jak vytvořit klientskou aplikaci pro Redque můstek:

  1. Klientskou aplikaci vytvoříte v sekci Nastavení > Klientské aplikace tlačítkem plus
  2. Vyplňte nastavení dle obrázku níže:
    client-creation-1.jpg
    1. Název: Uživatelsky přívětivý název klientské aplikace pro snadné rozlišení
    2. Oprávnění: Klientská aplikace má stejná oprávnění jako běžný uživatel s danou rolí. Dostupné role:
      • Nahrávač - může nahrávat dokumenty, vidí jen vlastní
      • Zpracovatel - může zpracovávat všechny dokumenty
      • Schvalovatel - může schvalovat a sdílet dokumenty
      • Administrátor - plný přístup ke všem funkcím
      • Zpracovatel účetní jednotky - zpracovatel omezený na přiřazené účetní jednotky
      • Schvalovatel účetní jednotky - schvalovatel omezený na přiřazené účetní jednotky
      • Více o oprávněních najdete v sekci Uživatelé
      • Doporučená oprávnění pro můstek najdete zde
    3. Nastavení účetních jednotek (pouze v případě, že používáte Účetní jednotky)
      • Klientská aplikace má přístup pouze k dokumentům svých přiřazených účetních jednotek
      • Výchozí účetní jednotka: primární účetní jednotka určující přístup k dokumentům
      • Další účetní jednotky: seznam dalších účetních jednotek s přístupem
      • Funguje stejně jako u uživatele
    4. Zaškrtávací pole "Aktivní": Přepínač pro aktivaci/deaktivaci klientské aplikace
      • Deaktivovaná klientská aplikace nemůže přistupovat k API
  3. Nastavení uložte tlačítkem save
  4. Zobrazí se dialog:
    client-creation-2.jpg
  5. Obě hodnoty si pečlivě uložte:

    • ID klienta (Client ID) - automaticky vygenerovaný identifikátor (nelze později změnit)
    • Heslo (Client Secret) - automaticky vygenerovaný tajný klíč, který se zobrazí POUZE PŘI VYTVOŘENÍ

    Kritické upozornění - Heslo se zobrazí pouze jednou

    ❗ Alice heslo klientské aplikace neukládá a nezobrazuje opakovaně. Client Secret se zobrazí POUZE při vytvoření aplikace. Pokud ho ztratíte, musíte vytvořit novou klientskou aplikaci.

Úprava klientské aplikace

Aplikaci můžete upravit ikonou edit a potvrzením volby.

Smazání klientské aplikace

Aplikaci můžete odebrat ikonou delete a potvrzením volby.

Smazání propojených dat

Při smazání klientské aplikace se smaže i propojený uživatelský účet. Tuto akci nelze vrátit zpět.

Použití klientské aplikace

Autentizace k API

Klientská aplikace se autentizuje k API pomocí Client ID a Client Secret. Po úspěšné autentizaci obdrží přístupový token, který používá pro volání API.

Postup autentizace:

  1. Vytvořte klientskou aplikaci v Nastavení → Klientské aplikace
  2. Při vytvoření si zkopírujte Client ID a Client Secret (SECRET SE ZOBRAZÍ POUZE JEDNOU!)
  3. Použijte Client ID a Client Secret pro získání přístupového tokenu
  4. Přístupový token použijte v hlavičce API požadavků

Detailní dokumentaci API najdete na api-docs.redque.com.

Integrace s webhooky

Klientskou aplikaci lze propojit s webhooky. Při spuštění webhooků se automaticky přidají přihlašovací údaje klientské aplikace do požadavku, což zajistí bezpečnou autentizaci.

Postup nastavení:

  1. Při konfiguraci webhooků v Nastavení → Webhooky vyberte klientskou aplikaci ze seznamu
  2. Webhook bude automaticky autentizován pomocí vybrané klientské aplikace
  3. Webhook bude mít stejná oprávnění jako klientská aplikace

Více o webhooky najdete v sekci Webhooky.

Seznam klientských aplikací

V hlavním přehledu klientských aplikací vidíte:

  • Název klientské aplikace
  • Přiřazená role (oprávnění)
  • Stav (aktivní/neaktivní)
  • Client ID
  • Akce (úprava, smazání)

V seznamu můžete klientské aplikace vyhledávat podle názvu nebo Client ID.

Klientské aplikace vs. běžní uživatelé

Klientské aplikace se nezobrazují v seznamu běžných uživatelů (karta Uživatelé). Mají však automaticky vytvořený uživatelský účet se stejnými oprávněními.

Pravidla a omezení

  • Název klientské aplikace nesmí být prázdný
  • Client ID nelze změnit po vytvoření aplikace
  • Client Secret se zobrazí pouze při vytvoření - nelze ho později zobrazit ani obnovit
  • Každá klientská aplikace má automaticky vytvořený uživatelský účet se stejnou rolí
  • Klientská aplikace má přístup pouze k dokumentům svých přiřazených účetních jednotek
  • Deaktivovaná klientská aplikace nemůže přistupovat k API
  • Správa klientských aplikací vyžaduje oprávnění Administrátora

Často kladené otázky

Co dělat, když ztratím Client Secret?

Client Secret se zobrazí pouze při vytvoření klientské aplikace a nelze ho později zobrazit ani obnovit. Pokud jste Client Secret ztratili, musíte vytvořit novou klientskou aplikaci a aktualizovat své integrace s novými přihlašovacími údaji.

Jaký je rozdíl mezi klientskou aplikací a běžným uživatelem?

Klientská aplikace je určena pro programatický přístup k API a nemůže se přihlásit do webového rozhraní Alice. Má stejná oprávnění jako běžný uživatel, ale používá se pro automatizace, integrace a webhooky.

Mohu změnit oprávnění existující klientské aplikace?

Ano, oprávnění (roli) klientské aplikace můžete změnit editací aplikace. Změna se projeví okamžitě a ovlivní všechny API požadavky autentizované touto aplikací.

Proč se mi klientská aplikace nezobrazuje v seznamu uživatelů?

Klientské aplikace mají vlastní sekci v nastavení (Nastavení → Klientské aplikace) a nezobrazují se v klasickém seznamu uživatelů. To je záměrné, aby bylo možné snadno odlišit programatický přístup od běžných uživatelských účtů.

Mohu přiřadit klientské aplikaci více účetních jednotek?

Ano, stejně jako u běžných uživatelů můžete klientské aplikaci přiřadit výchozí účetní jednotku a další účetní jednotky, ke kterým bude mít přístup.