Mailfrom hooks: przetwarzanie dokumentów przez e-mail

Przetwarzanie dokumentów przez e-mail za pomocą mailfrom hooks: unikalny adres tokenowy, transformacja i własna domena.

Nie każdy system jest w stanie dostarczać dokumenty przez połączenie API. Za pomocą mailfrom hook umożliwiasz przesyłanie dokumentów jako załączników e-mailowych do PSB. PSB generuje unikalny adres e-mail z tokenem (na przykład dj8fwhrqxjhw@econnect.email). Każdy dokument wysłany jako załącznik na ten adres jest automatycznie przetwarzany jako faktura, zamówienie lub inny typ dokumentu.

Odbiornik e-mail PSB jest celowo prosty ("głupi"): wszystkie pliki z załącznika e-mail są przetwarzane jako nowy dokument bez dalszej interpretacji. Technicznie PSB wykorzystuje do tego SendGrid Inbound Parse.

Jak działa mailfrom hook?

Podczas tworzenia mailfrom hook PSB generuje unikalny adres tokenowy. Za pomocą publishTopic konfigurujesz, co powinno się stać z przychodzącymi dokumentami, na przykład wysłanie przez Peppol (SendInvoice) lub przetworzenie jako otrzymany dokument (ReceiveInvoice).

Przebieg jest następujący:

  1. Rejestrujesz mailfrom hook z publishTopic
  2. PSB generuje unikalny adres e-mail z tokenem
  3. Użytkownik lub system wysyła e-mail z załącznikiem dokumentu na ten adres
  4. PSB przetwarza załączniki jako dokumenty i publikuje je na określonym temacie
  5. Wszelkie dalsze akcje (wysyłanie, transformacja) są wykonywane automatycznie
Tworzenie mailfrom hook

Zarejestruj hook za pomocą API z akcją mailfrom://. Użyj $token$ jako placeholdera; PSB zamieni go na wygenerowany token w odpowiedzi. Zobacz też dokumentację PSB: Mail from.

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

Po rejestracji odpowiedź zawiera rzeczywisty adres tokenowy:

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

Od tego momentu wszystkie załączniki wysłane na adres dj8fwhrqxjhw@econnect.email są przetwarzane jako faktury i publikowane na temacie SendInvoice.

Format akcji

Akcja składa się z części from i to:

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

Adres tokenowy może być umieszczony zarówno w części from, jak i to. Co najmniej jedna z nich musi zawierać token, aby PSB mógł powiązać e-mail z właściwym hookiem.

Warianty
KonfiguracjaOpismailfrom://*&to=$token$@econnect.emailAkceptuje e-maile od dowolnego nadawcy, token w adresie odbiorcymailfrom://$token$@example.com&to=inbound@econnect.emailToken w adresie nadawcy, stały adres odbiorcy. Przydatne przy własnej domenie

Symbol wieloznaczny * w części from oznacza, że akceptowane są e-maile od dowolnego adresu nadawcy. Jeśli chcesz ograniczyć, którzy nadawcy mogą przesyłać dokumenty, wpisz konkretny adres e-mail.

Środowiska
ŚrodowiskoDomena e-mailAkceptacja@accp.econnect.emailProdukcja@econnect.email

Uwaga: zawsze używaj właściwej domeny dla danego środowiska. E-maile wysłane na domenę produkcyjną są przetwarzane jako prawdziwe dokumenty i nie można tego cofnąć.

Transformacja dokumentów

Opcjonalnie możesz podać sourceDocumentTypeId i targetDocumentTypeId jako parametry query. PSB automatycznie transformuje załącznik do określonego formatu docelowego, pod warunkiem że dostępna jest odpowiednia transformacja. Znaki specjalne w documentTypeId muszą być zakodowane URL.

{
  "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 obsługuje dokładnie jeden publishTopic. Ten temat określa, jak PSB przetwarza przychodzące dokumenty.

Publish topicZastosowanieSendInvoiceWyślij fakturę przez skonfigurowany kanał (np. Peppol)ReceiveInvoiceZarejestruj dokument jako otrzymaną fakturęRecognizeSalesInvoicePrześlij dokument do IDR w celu rozpoznania PDF

Wskazówka: używając RecognizeSalesInvoice jako publish topic, możesz przesyłać faktury PDF e-mailem i mieć je automatycznie rozpoznawane przez IDR. To łączy mailfrom z inteligentnym rozpoznawaniem dokumentów.

Własna domena

Domyślnie PSB używa domeny econnect.email (lub accp.econnect.email dla środowiska akceptacyjnego). Możliwe jest również użycie własnej domeny, aby adres e-mail odpowiadał Twojej organizacji. Skontaktuj się z eConnect, aby to skonfigurować.

Uwagi
  • Mailfrom hooks przetwarzają wyłącznie załączniki. Treść e-maila nie jest przetwarzana jako dokument.
  • Każdy hook obsługuje maksymalnie jeden publishTopic. Dla różnych typów przetwarzania (wysyłanie, odbieranie, rozpoznawanie) tworzysz osobne hooki.
  • Upewnij się, że załączniki są w obsługiwanym formacie (XML, PDF). Inne typy plików nie są przetwarzane.
Często zadawane pytania
Dlaczego w action mailfrom używa się placeholdera $token$?

Podczas rejestracji PSB zastępuje $token$ wygenerowanym unikalnym tokenem w adresie e-mail; odpowiedź zawiera ostateczną ścieżkę mailfrom://. Tylko adresy z tym tokenem są powiązane z hookiem, dzięki czemu przychodząca poczta jest przetwarzana w sposób ukierunkowany.

Która domena e-mail odpowiada środowisku akceptacyjnemu, a która produkcyjnemu?

Dla środowiska akceptacyjnego używa się adresów na @accp.econnect.email, dla produkcji na @econnect.email. Wiadomości e-mail na domenę produkcyjną są przetwarzane jako rzeczywiste przepływy dokumentów i nie można ich łatwo cofnąć; środowisko należy wybierać świadomie.

Czy można łączyć wiele typów przetwarzania (wysyłanie, odbieranie, rozpoznawanie) w jednym mailfrom hooku?

Nie: mailfrom hook obsługuje dokładnie jeden publishTopic. Dla różnych typów przetwarzania, takich jak SendInvoice, ReceiveInvoice lub RecognizeSalesInvoice, tworzy się osobne hooki, każdy z własnym adresem tokenowym i publish topic.


Pełna specyfikacja API jest dostępna na psb.econnect.eu ze wszystkimi opcjami konfiguracji i przykładami.

Zobacz dokumentację API