Přejít na hlavní obsah
Integrace Webhooky je určena pro vývojáře. Kdykoli se ve Foliantu něco stane, odešle událost JSON na zvolenou adresu HTTPS. Váš vlastní systém pak může reagovat, například uložit PDF každé faktury nebo převzít hotový export. Webhooky jsou ve verzi beta. Pokud je v Nastavení › Integrace nevidíte, pro váš obchod zatím nejsou k dispozici. O přístup požádejte podporu.

Události

Propojení webhooků

  1. Ve Foliantu přejděte do Nastavení › Integrace.
  2. U položky Webhooky klikněte na Propojit.
  3. Vyplňte nastavení:
  4. Klikněte na Propojit.
URL, klíč a události můžete později změnit v části Nastavení na stránce integrace.

Co obsahuje každý požadavek

Foliant odešle požadavek POST s tělem JSON:

Data document.generated

  • template: uuid a name šablony.
  • document_type: invoice, credit_note, quote, nebo prázdné u jiných dokumentů.
  • order: její id, name a type (objednávky nebo koncepty objednávek).
  • refund_id a fulfillment_id, pokud je dokument k refundaci nebo zásilce.
  • document_number a issued_at u číslovaných dokumentů.
  • source: jak dokument vznikl, například download, admin_download, export nebo email.
  • export: ID exportu, pokud je dokument součástí exportu.
  • generated_at.

Data export.completed

  • export: jeho uuid, order_type, template_uuids, počet orders, orders_skipped (smazané po výběru) a documents, requested_by (merchant nebo customer) a completed_at.
  • download_url: odkaz ke stažení exportu a download_url_expires_at, kdy tento odkaz přestane fungovat.
  • download_expires_at: kdy vyprší platnost samotného exportu.
Události obsahují ID a počty, nikoli e-mailové adresy zákazníků.

Hlavičky

Ověření podpisu

Podpis je hexadecimální HMAC-SHA256 z časového razítka, tečky a nezpracovaného těla požadavku (<timestamp>.<body>), s vaším podpisovým klíčem jako klíčem. Vypočítejte ho na své straně a porovnejte s hodnotou za sha256= v X-Foliant-Signature. Použijte nezpracované tělo přesně tak, jak bylo přijato.

Odpovědi a opakované pokusy

  • Jakákoli odpověď 2xx se počítá jako doručení.
  • Pokud váš endpoint vrátí chybu 5xx, 408 nebo 429, nebo neodpoví do 10 sekund, Foliant to zkusí později znovu, pokaždé s delším odstupem, nejvýše 5 pokusů.
  • Ostatní odpovědi 4xx jsou konečné: Foliant je neopakuje.
  • Každá událost se doručí jednou na dokument nebo export. Opakované pokusy ji po úspěchu nikdy neodešlou dvakrát.
Každé doručení se zobrazí v části Aktivita na stránce integrace, kde můžete neúspěšné doručení Zkusit znovu. Viz Aktivita integrace.

Související články