Mailfrom hooks: zpracování dokumentů přes e-mail

Zpracování dokumentů přes e-mail pomocí mailfrom hooks: unikátní tokenová adresa, transformace a vlastní doména.

Ne každý systém dokáže doručovat dokumenty přes API připojení. Pomocí mailfrom hook umožníte odesílání dokumentů jako e-mailových příloh do PSB. PSB vygeneruje unikátní e-mailovou adresu s tokenem (například dj8fwhrqxjhw@econnect.email). Jakýkoliv dokument odeslaný jako příloha na tuto adresu je automaticky zpracován jako faktura, objednávka nebo jiný typ dokumentu.

E-mailový přijímací prvek PSB je záměrně jednoduchý ("hloupý"): všechny soubory z e-mailové přílohy jsou zpracovány jako nový dokument bez další interpretace. Technicky PSB pro to používá SendGrid Inbound Parse.

Jak mailfrom hook funguje?

Při vytváření mailfrom hook PSB vygeneruje unikátní tokenovou adresu. Pomocí publishTopic nakonfigurujete, co se má stát s příchozími dokumenty, například odeslání přes Peppol (SendInvoice) nebo zpracování jako přijatý dokument (ReceiveInvoice).

Průběh je následující:

  1. Zaregistrujete mailfrom hook s publishTopic
  2. PSB vygeneruje unikátní e-mailovou adresu s tokenem
  3. Uživatel nebo systém odešle e-mail s dokumentem v příloze na tuto adresu
  4. PSB zpracuje přílohy jako dokumenty a publikuje je na určeném tématu
  5. Případné navazující akce (odeslání, transformace) se provedou automaticky
Vytvoření mailfrom hook

Zaregistrujte hook přes API s akcí mailfrom://. Použijte $token$ jako placeholder; PSB ho nahradí vygenerovaným tokenem v odpovědi. Viz také dokumentaci PSB: Mail from.

{
  "id": "1",
  "name": "mail from trigger",
  "action": "mailfrom://*&to=$token$@econnect.email",
  "publishTopics": [
    "SendInvoice"
  ],
  "isActive": true
}

Po registraci odpověď obsahuje skutečnou tokenovou adresu:

mailfrom://*&to=dj8fwhrqxjhw@econnect.email

Od tohoto okamžiku jsou všechny přílohy odeslané na dj8fwhrqxjhw@econnect.email zpracovány jako faktury a publikovány na tématu SendInvoice.

Formát akce

Akce se skládá z části from a to:

mailfrom://{from}&to={to}

Tokenová adresa může být umístěna buď v části from, nebo to. Alespoň jedna z nich musí obsahovat token, aby PSB mohl propojit e-mail se správným hookem.

Varianty
KonfiguracePopismailfrom://*&to=$token$@econnect.emailPřijímá e-maily od libovolného odesílatele, token v adrese příjemcemailfrom://$token$@example.com&to=inbound@econnect.emailToken v adrese odesílatele, pevná adresa příjemce. Užitečné s vlastní doménou

Zástupný znak * v části from znamená, že jsou akceptovány e-maily od jakékoliv adresy odesílatele. Pokud chcete omezit, kteří odesílatelé mohou dokumenty odesílat, zadejte konkrétní e-mailovou adresu.

Prostředí
ProstředíE-mailová doménaAkceptace@accp.econnect.emailProdukce@econnect.email

Poznámka: vždy používejte správnou doménu pro dané prostředí. E-maily odeslané na produkční doménu jsou zpracovány jako skutečné dokumenty a nelze to vrátit zpět.

Transformace dokumentů

Volitelně můžete zadat sourceDocumentTypeId a targetDocumentTypeId jako query parametry. PSB poté automaticky transformuje přílohu do určeného cílového formátu, pokud je k dispozici vhodná transformace. Speciální znaky v documentTypeId musí být URL-kódovány.

{
  "id": "1",
  "name": "mail from met transformatie",
  "action": "mailfrom://*&to=$token$@econnect.email?sourceDocumentTypeId=urn%3Aoasis%3Anames%3Aspecification%3Aubl%3Aschema%3Axsd%3AInvoice-2%3A%3AInvoice%23%23urn%3Acen.eu%3Aen16931%3A2017%23compliant%23urn%3Afdc%3Anen.nl%3Anlcius%3Av1.0%3A%3A2.1&targetDocumentTypeId=urn%3Aoasis%3Anames%3Aspecification%3Aubl%3Aschema%3Axsd%3AInvoice-2%3A%3AInvoice%23%23urn%3Acen.eu%3Aen16931%3A2017%23compliant%23urn%3Afdc%3Anen.nl%3Anlcius%3Av1.0%3A%3A2.1",
  "publishTopics": [
    "SendInvoice"
  ],
  "isActive": true
}
Publish topics

Mailfrom hook podporuje právě jeden publishTopic. Toto téma určuje, jak PSB zpracuje příchozí dokumenty.

Publish topicPoužitíSendInvoiceOdeslat fakturu přes nakonfigurovaný kanál (např. Peppol)ReceiveInvoiceZaregistrovat dokument jako přijatou fakturuRecognizeSalesInvoiceOdeslat dokument do IDR pro rozpoznání PDF

Tip: použitím RecognizeSalesInvoice jako publish topic můžete odesílat PDF faktury e-mailem a nechat je automaticky rozpoznat IDR. Tím kombinujete mailfrom s inteligentním rozpoznáváním dokumentů.

Vlastní doména

Ve výchozím nastavení PSB používá doménu econnect.email (nebo accp.econnect.email pro akceptaci). Je také možné použít vlastní doménu, aby e-mailová adresa odpovídala vaší organizaci. Kontaktujte eConnect pro nastavení.

Na co dát pozor
  • Mailfrom hooks zpracovávají pouze přílohy. Textové tělo e-mailu samotného není zpracováno jako dokument.
  • Každý hook podporuje maximálně jeden publishTopic. Pro různé typy zpracování (odesílání, přijímání, rozpoznávání) vytvořte samostatné hooky.
  • Ujistěte se, že přílohy jsou v podporovaném formátu (XML, PDF). Jiné typy souborů nejsou zpracovány.
Často kladené otázky
Proč se v action mailfrom používá placeholder $token$?

Při registraci PSB nahradí $token$ vygenerovaným unikátním tokenem v e-mailové adrese; odpověď obsahuje definitivní cestu mailfrom://. K Vašemu hooku jsou přiřazeny pouze adresy s tímto tokenem, takže příchozí pošta je zpracovávána cíleně.

Která e-mailová doména patří k akceptaci a která k produkci?

Pro akceptaci používáte adresy na @accp.econnect.email, pro produkci na @econnect.email. E-maily na produkční doménu jsou zpracovávány jako skutečné dokumentové toky a nelze je jednoduše vrátit; prostředí proto vybírejte vědomě.

Je možné kombinovat více typů zpracování (odesílání, přijímání, rozpoznávání) v jednom mailfrom hooku?

Ne: mailfrom hook podporuje přesně jeden publishTopic. Pro různé typy zpracování, jako SendInvoice, ReceiveInvoice nebo RecognizeSalesInvoice, vytvoříte samostatné hooky, každý s vlastní tokenovou adresou a publish topic.


Kompletní API specifikace je k dispozici na psb.econnect.eu se všemi konfiguračními možnostmi a příklady.

Zobrazit API dokumentaci