Ugrás a fő tartalomhoz
A Webhooks integráció fejlesztőknek készült. JSON eseményt küld egy Ön által választott HTTPS-címre, valahányszor történik valami a Foliantban, így az Ön saját rendszere reagálni tud rá, például minden számla PDF-jét iktathatja, vagy átveheti az elkészült exportálást. A Webhooks béta állapotban van. Ha nem látja a Beállítások › Integrációk oldalon, akkor az Ön áruháza számára még nem érhető el. A hozzáférésért forduljon az ügyfélszolgálathoz.

Események

A webhookok csatlakoztatása

  1. A Foliantban nyissa meg a Beállítások › Integrációk oldalt.
  2. A Webhooks kártyán kattintson a Csatlakoztatás gombra.
  3. Töltse ki a beállításokat:
  4. Kattintson a Csatlakoztatás gombra.
Az URL-címet, a titkot és az eseményeket később az integráció oldalán, a Beállítások részben módosíthatja.

Mit tartalmaz az egyes kérés

A Foliant POST kérést küld JSON törzzsel:

A document.generated adatai

  • template: a sablon uuid és name értéke.
  • document_type: invoice, credit_note, quote, vagy üres más dokumentumok esetén.
  • order: a rendelés id, name és type értéke (rendelések vagy rendelésvázlatok).
  • refund_id és fulfillment_id, ha a dokumentum visszatérítéshez vagy szállítmányhoz tartozik.
  • document_number és issued_at, számozott dokumentumok esetén.
  • source: hogyan készült, például download, admin_download, export vagy email.
  • export: az exportálás azonosítója, ha a dokumentum egy exportálás része.
  • generated_at.

Az export.completed adatai

  • export: az exportálás uuid, order_type, template_uuids értéke, a rendelések száma (orders), az orders_skipped (a kiválasztásuk után törölt rendelések) és a documents értéke, a requested_by (merchant vagy customer) és a completed_at.
  • download_url: hivatkozás az exportálás letöltéséhez, valamint download_url_expires_at, amikor ez a hivatkozás megszűnik működni.
  • download_expires_at: amikor maga az exportálás lejár.
Az események azonosítókat és darabszámokat tartalmaznak, vásárlói e-mail-címeket nem.

Fejlécek

Az aláírás ellenőrzése

Az aláírás az időbélyeg, egy pont és a nyers kéréstörzs (<timestamp>.<body>) hexadecimális HMAC-SHA256 értéke, kulcsként az Ön aláírási titkát használva. Számítsa ki a saját oldalán, és vesse össze az X-Foliant-Signature fejlécben a sha256= utáni értékkel. A nyers törzset pontosan úgy használja, ahogy megkapta.

Válaszok és újrapróbálkozások

  • Bármely 2xx válasz kézbesítettnek számít.
  • Ha az Ön végpontja 5xx hibát, 408-at vagy 429-et ad vissza, vagy 10 másodpercen belül nem válaszol, a Foliant később újra megpróbálja, egyre hosszabb várakozással, legfeljebb 5 kísérletig.
  • A többi 4xx válasz végleges: ezeket a Foliant nem próbálja újra.
  • Minden esemény dokumentumonként vagy exportálásonként egyszer kerül kézbesítésre. Sikeres kézbesítés után az újrapróbálkozások soha nem küldik el kétszer.
Minden kézbesítés megjelenik az integráció oldalán a Tevékenység részben, ahol a sikertelenekre az Újrapróbálás gombbal újra kísérletet tehet. Lásd: Integrációs tevékenység.

Kapcsolódó cikkek