nopCommerce Dokumentace

PunchOut

PunchOut je nákupní protokol, který bezproblémově propojuje váš obchod s podnikovými nákupními (procurement) systémy odběratelů, jako jsou SAP Ariba, Coupa, Oracle eProcurement a další. Umožňuje nákupčím přistupovat k vašemu obchodu přímo z jejich nákupního systému, procházet katalog a přidávat produkty do nákupního košíku, aniž by opustili svůj nákupní proces. Obsah košíku se poté přenese zpět do nákupního systému jako požadavek na nákup (requisition).

V nopCommerce je integrace implementována jako plugin PunchOut cXML Integration (systémový název Misc.PunchOut) a je k dispozici od nopCommerce 5.00. Plugin patří do skupiny Misc a implementuje protokol PunchOut pomocí cXML (verze 1.2.014).

Jak to funguje

  1. Nákupní systém odešle do vašeho obchodu PunchOutSetupRequest (dokument cXML).
  2. nopCommerce požadavek ověří, vytvoří relaci PunchOut a vrátí PunchOutSetupResponse obsahující URL úvodní stránky (Start Page URL).
  3. Uživatel je z nákupního systému přesměrován do veřejné části obchodu nopCommerce a je automaticky přihlášen.
  4. Uživatel prochází katalog a přidává produkty do nákupního košíku jako obvykle.
  5. Během aktivní relace PunchOut je standardní tlačítko Pokladna (Checkout) nahrazeno tlačítkem Odeslat ke schválení (Submit for Approval).
  6. Po kliknutí na Odeslat ke schválení nopCommerce z aktuálního nákupního košíku vygeneruje PunchOutOrderMessage (cXML).
  7. Prohlížeč automaticky odešle PunchOutOrderMessage zpět do nákupního systému pomocí URL BrowserFormPost uvedené v původním požadavku na nastavení.
  8. Nákupní systém na základě přijatých dat košíku vytvoří nebo aktualizuje požadavek na nákup.
  9. V nopCommerce se nevytvoří žádná objednávka a zpracování platby se přeskočí.
  10. Relace PunchOut se dokončí a uživatel se vrátí do nákupního systému.

Poznámka

  • Relace PunchOut se ukládají do databáze a automaticky vyprší.
  • Všechny příchozí a odchozí dokumenty cXML se zaznamenávají do protokolu pro účely auditu a řešení problémů.
  • Pomocí samostatných přihlašovacích údajů klientů PunchOut lze nakonfigurovat více nákupních systémů.
  • U aktivních relací PunchOut se standardní proces pokladny nopCommerce obchází.

Instalace pluginu

  1. Přejděte do Konfigurace → Lokální pluginy (Configuration → Local plugins).
  2. Vyhledejte PunchOut cXML Integration v poli Název pluginu (Plugin name). Plugin patří do skupiny Misc.
  3. Klikněte na tlačítko Instalovat (Install).
  4. Kliknutím na tlačítko Restartovat aplikaci pro uplatnění změn (Restart application to apply changes) změny uplatníte.

Konfigurace pluginu

Plugin nakonfigurujete v Konfigurace → Lokální pluginy (Configuration → Local plugins) kliknutím na Konfigurovat (Configure) vedle PunchOut cXML Integration.

Stránka konfigurace obsahuje následující sekce:

  • Obecná nastavení (Common settings) — obecná nastavení pluginu.
  • Identita (Identity) — přihlašovací údaje klientů PunchOut, kteří se smějí připojit k vašemu obchodu.
  • Relace (Session) — aktivní a dokončené relace PunchOut.
  • Protokol (Log) — příchozí a odchozí dokumenty cXML.

Definujte následující obecná nastavení:

PunchOut

  • Je aktivní (Is active) — zapnutí nebo vypnutí pluginu. Plugin je ve výchozím stavu vypnutý; když je vypnutý, nopCommerce odpovídá na příchozí požadavky na nastavení chybou Service Unavailable.
  • Doba do vypršení (Time to expire) — doba v hodinách, po které relace PunchOut vyprší (ve výchozím stavu 24 hodin).
  • Kód měrné jednotky (Unit of measure code) - kód měrné jednotky pro relaci PunchOut.
  • Omezené role zákazníků (Restricted customer roles) — vyberte role zákazníků, které nebudou mít přístup k funkci PunchOut. Pokud není vybrána žádná role, budou mít přístup všichni zákazníci. Ve výchozím stavu je omezena role Administrátoři.

Kliknutím na Uložit (Save) změny uložíte.

Konfigurace identit

Nákupní systém se ověřuje pomocí přihlašovacích údajů Identity a Shared secret odeslaných v elementu Sender požadavku na nastavení. nopCommerce přihlašovací údaje ověří a požadavky s neplatným sdíleným tajemstvím odmítne.

V sekci Identita (Identity) spravujte odesílatele, kteří se smějí připojit k vašemu obchodu:

PunchOut

  • Pomocí vyhledávacího pole můžete filtrovat identity podle hodnoty identity.
  • Tabulka obsahuje sloupce Identita (Identity) a Hash sdíleného tajemství (Shared secret hash). Obě hodnoty lze upravovat přímo v řádku. Když změníte hodnotu ve sloupci „Hash sdíleného tajemství“, ve skutečnosti zadáváte nový tajný klíč, který se poté zahashuje.
  • K správě identit použijte tlačítka Upravit (Edit) a Smazat (Delete).
  • V bloku Přidat nový záznam (Add new record) zadejte Identitu (Identity) a Sdílené tajemství (Shared secret) nákupního systému a klikněte na tlačítko Přidat nový záznam (Add new record).

Důležité

Sdílené tajemství se ukládá jako hash SHA-256. Identitu a sdílené tajemství předejte administrátorovi nákupního systému, aby bylo možné stejné přihlašovací údaje nakonfigurovat na straně nákupního systému. PunchOut

Relace PunchOut ve veřejné části obchodu

Když nákupčí přejde na URL úvodní stránky, nopCommerce aktivuje relaci a nákupčího automaticky přihlásí. Pokud zákazník s kontaktním e-mailem z požadavku na nastavení neexistuje, vytvoří se nový zákazník a přiřadí se k roli zákazníka Registrovaní. Adresa ShipTo z požadavku na nastavení se uloží jako doručovací adresa zákazníka.

Během aktivní relace PunchOut:

  • Nákupčí může procházet pouze domovskou stránku, katalog, stránky produktů a nákupní košík; přechod na jakoukoli jinou stránku je přesměrován na domovskou stránku.
  • Standardní tlačítko Pokladna (Checkout) je nahrazeno tlačítkem Odeslat ke schválení (Submit for Approval) a slevy na položky jsou na stránce košíku skryté.
  • Pokladna, kontaktní formuláře, recenze produktů a stránky zákaznického účtu (informace o účtu, registrace, obnovení hesla, adresy, produkty ke stažení, avatar, nástroje GDPR, zůstatek dárkového poukazu, vícefaktorové ověřování) nejsou k dispozici.
  • Recenze produktů jsou na stránkách detailu produktu vypnuté.

Pokud relace vyprší, data relace se vymažou a nákupčí je přesměrován na domovskou stránku s upozorněním Your PunchOut session has expired.

Správa relací

Sekce Relace (Session) obsahuje seznam relací PunchOut s ID relace, cookie nákupčího, stavem aktivity, e-mailem zákazníka (s odkazem na stránku úpravy zákazníka), obchodem a datem vytvoření. Relaci můžete ručně ukončit tlačítkem Ukončit relaci (Close Session).

PunchOut

Zobrazení protokolu

Sekce Protokol (Log) obsahuje seznam všech příchozích a odchozích dokumentů cXML. Každý záznam obsahuje ID relace, typ zprávy (SetupRequest, SetupResponse nebo OrderMessage) a datum vytvoření. Protokol můžete filtrovat podle data vytvoření.

PunchOut

Kliknutím na tlačítko Zobrazit (View) zobrazíte podrobnosti záznamu: ID relace, typ zprávy, směr (Inbound — z nákupního systému do nopCommerce, nebo Outbound — z nopCommerce do nákupního systému), nezpracované XML, URL, identitu, chybovou zprávu (pokud existuje) a datum vytvoření. Jednotlivé záznamy můžete smazat na stránce záznamu protokolu, nebo celý protokol vymazat tlačítkem Vymazat protokol (Clear log).

Zprávy cXML

Plugin implementuje následující zprávy cXML (verze 1.2.014):

  • PunchOutSetupRequest — odesílá ji nákupní systém na POST /punchout/setup. nopCommerce z ní načte přihlašovací údaje odesílatele, cookie nákupčího, URL BrowserFormPost, kontaktní e-mail a adresu ShipTo.
  • PunchOutSetupResponse — vrací ji nopCommerce. Obsahuje URL úvodní stránky (/punchout/start?sessionId=...), která nákupčího přesměruje do veřejné části obchodu.
  • PunchOutOrderMessage — generuje se z aktuálního nákupního košíku a odesílá se na URL BrowserFormPost. Obsahuje cookie nákupčího, celkovou částku košíku a položky košíku s SKU produktu (SupplierPartID), popisem (název produktu a hodnoty atributů), množstvím, jednotkovou cenou a měnou.

Chybové odpovědi používají standardní element cXML Response/Status s příslušným stavovým kódem: 401 pro neplatné sdílené tajemství, 400 pro chybně formátovaný požadavek a 503, když je plugin vypnutý.

Další informace

Přispěvatelé: DmitriyKulagin
Upravit na GitHubu