Salt la conținutul principal
Integrarea Webhooks este destinată dezvoltatorilor. Aceasta trimite un eveniment JSON la o adresă HTTPS aleasă de dumneavoastră ori de câte ori se întâmplă ceva în Foliant, astfel încât propriul sistem să poată reacționa, de exemplu arhivând fiecare factură PDF sau preluând un export finalizat. Webhooks este în versiune beta. Dacă nu o vedeți în Setări › Integrări, nu este încă disponibilă pentru magazinul dvs. Contactați asistența pentru a solicita acces.

Evenimente

Conectați webhookurile

  1. În Foliant, accesați Setări › Integrări.
  2. La Webhooks, faceți clic pe Conectați.
  3. Completați setările:
  4. Faceți clic pe Conectați.
Puteți modifica ulterior URL-ul, secretul și evenimentele din Setări, pe pagina integrării.

Ce conține fiecare cerere

Foliant trimite o cerere POST cu un corp JSON:

Datele document.generated

  • template: uuid și name ale șablonului.
  • document_type: invoice, credit_note, quote sau gol pentru alte documente.
  • order: id, name și type ale comenzii (comenzi sau comenzi preliminare).
  • refund_id și fulfillment_id, când documentul este pentru o rambursare sau o expediere.
  • document_number și issued_at, pentru documentele numerotate.
  • source: modul în care a fost creat, de exemplu download, admin_download, export sau email.
  • export: ID-ul exportului, când face parte dintr-un export.
  • generated_at.

Datele export.completed

  • export: uuid, order_type, template_uuids, numărul de orders, orders_skipped (șterse după ce au fost alese) și documents, requested_by (merchant sau customer) și completed_at.
  • download_url: un link pentru descărcarea exportului și download_url_expires_at, momentul în care acest link nu mai funcționează.
  • download_expires_at: momentul în care expiră exportul în sine.
Evenimentele conțin ID-uri și numere, nu adrese de e-mail ale clienților.

Antete

Verificați semnătura

Semnătura este un HMAC-SHA256 hexazecimal al marcajului de timp, al unui punct și al corpului brut al cererii (<timestamp>.<body>), folosind secretul de semnare drept cheie. Calculați-o pe partea dvs. și comparați-o cu valoarea de după sha256= din X-Foliant-Signature. Folosiți corpul brut exact așa cum a fost primit.

Răspunsuri și reîncercări

  • Orice răspuns 2xx este considerat livrat.
  • Dacă endpointul dvs. returnează o eroare 5xx, 408 sau 429 ori nu răspunde în 10 secunde, Foliant încearcă din nou mai târziu, așteptând tot mai mult de fiecare dată, până la 5 încercări.
  • Celelalte răspunsuri 4xx sunt definitive: Foliant nu le reîncearcă.
  • Fiecare eveniment este livrat o singură dată per document sau export. Reîncercările nu îl trimit niciodată de două ori după un succes.
Fiecare livrare apare în Activitate pe pagina integrării, unde puteți folosi Reîncercați pentru una eșuată. Consultați Activitatea integrării.

Articole conexe