Automatické zpracování objednávek
a propojení s jiným systémem (účetnictví, CRM ..)
Automatický import stavů objednávek do internetového obchodu systému ClickEshop a export objednávek do účetního nebo výrobního systému.
Automatizované propojení probíhají na pozadí plně autonomně, bez zásahu člověka kde se posílají nebo přijímají data, a tím jsou schopny nahradit některé monotónně operace, jako například každodenní import / export objednávek do internetového obchodu. Neexistence duplicitních procesů se sebou přináší ušetřené prostředky k obsluze internetového obchodu, ale pomáhá i vyvarovat se zbytečným chybám v podobě nepřesných informací a následnému zklamání zákazníka. Automatizovaný import / export objednávek zajistí pravidelnou aktualizaci objednávek v internetovém obchodě nebo v externích systémech bez ohledu na to jestli jste jako administrátor do internetového obchodu vstoupili.
1 AUTOMATIZOVANÝ IMPORT STAVŮ OBJEDNÁVEK
Automatizovaný import je možné využít při změně stavů objednávek, které se importují do internetového obchodu z účetních, výrobních, expedičních nebo logistických systémů.
1.1 Architektura řešení
Celé řešení je založeno na možnosti naplánovat vlastní automatizovaný import za předpokladu dodržení
stanovených podmínek:
- připravit a zpracovat XML feed do předepsané standardní struktury a zpřístupnit ho v úložišti
- připravit vlastní spouštěcí skript s autentifikací který bude volat api rozhraní
- naplánovat automatizované spouštění na základě dohody s provozovatelem ClickEshop
1.2 Požadavky na strukturu XML feedu
Systém podporuje automatický import stavů objednávek za předpokladu dodržení standardní struktury XML feedu.
Kódování = UTF-8
Vzor šablony XML feedu pro import (upload):
<?xml version="1.0"?>
<datapack date="2016-01-14 13:27:10" project="www.myeshop.clickeshop.com">
<order id="20105816">
<stateId>1</stateId>
<sendEmail>1</sendEmail>
<sendInvoice>1</sendInvoice>
<orderDescr><![CDATA[Delivery parcel number 70112399/895]]></orderDescr>
</order>
<order id="20105815">
<stateId>4</stateId>
<sendEmail>0</sendEmail>
<sendInvoice>0</sendInvoice>
<orderDescr><![CDATA[Other description]]></orderDescr>
</order>
</datapack>
XML soubor bude importován jako komprimovaný XML soubor ve formátu ZIP
Popis parametrů XML feedu:
| Název parametru | Popis |
| order id | Číslo objednávky |
| stateId | ID stavu objednávky |
| sendEmail | 1 / odeslat email o změně stavu objednávky 0 / neodeslat email |
| sendInvoice | 1 / připojit fakturu do emailu 0 / odeslat email bez faktury |
| orderDescr | Dodatečný popis připojený do odesílaného emailu |
1.3 API rozhraní
slouží pro automatizované zpracování XML souboru (upload XML souboru s informacemi o aktuálním stavu objednávek) při propojení ClickEshopu s jinými systémy. Na API rozhraní lze naprogramovat uživatelskou aplikaci.
Cesta k API rozhraní na automatizovaný import stavů objednávek:
https://clickeshop.com/admin_eshop/batch/import_orders.php
XML soubor bude importován jako komprimovaný XML soubor ve formátu ZIP
Parametry API (použití metodou POST)
| Název parametru | Povinný parametr | Popis |
| login | Ano | Postup pro vytvoření login je následující: 1) Přihlásit se do administrace daného eshopu 2) Zvolit sekci Globální nastavení - Uživatelé 3) Vyplnit "Email uživatele:" 4) Role "STANDARD" Oprávnění: žádné! 5) Uložit Na zaregistrovaný mail přijde heslo |
| password | Ano | Po vložení nového uživatele v sekci Globální nastavení - Uživatelé přijde na zaregistrovaný mail nové heslo, které se použije při autentifikaci |
| id_project | Ano | Třeba požádat podporu o přidělení ID. Požadavek musí by být zaslán z kontaktního formuláře přímo z administrace eshopu (Pomoc - Zákaznická podpora) |
| file_data | Ano | ve formátu $_FILES['file_data'] jako komprimovaný XML soubor ve standardním formátu ZIP (nazov.zip) |
1.4 Výpis zpracování dat (log)
Výsledek log ze zpracování automatického importu bude přístupný v sekci: Globální nastavení - Hromadný import
Zaznamenaný a zobrazený je vždy poslední log z importu.
1.5 Omezení
- soubor, který se importuje může mít maximálně 10 MB (zip). V případě, že je soubor větší, tak se rozdělí na více dávek. V reálném čase lze zpracovávat najednou pouze jeden import
- API je možné volat maximálně 180 krát za 1 konkrétní den
- API je možné volat pouze přes šifrované spojení SSL https:
1.6 Chybové stavy
Server odpověď na output:
{"result":"ERR"} – Chyba, akcia sa nevykonala
{"result":"OK"} – Akcia sa vykonala
Server odpověď v HTTP header ( HTTP Status Codes ):
200 – request success
400 – error, bad request
1.7 Vzor testovacího HTML formuláře
Pro produkční účely doporučujeme vytvořit si jednoduchou .NET aplikaci na HTTP post parametrů (kód na pár řádků). Také se dá použít open-source aplikace CURL, která se zavolá přes parametry a tato umí POST komprimovaným XML soubor i s danými parametry na server clickeshop.
Pro testovací účely stačí pro HTTP post následující HTML formulář:
https://clickeshop.com/admin_eshop/batch/test-import_orders.html
Pro zjednodušení implementace doporučujeme si prohlédnout zdrojový kód HTML testovacího formuláře.
2 AUTOMATIZOVANÝ EXPORT
Automatizovaný export je možné využít při automatickém zpracování objednávek z internetového obchodu, které se exportují do účetních, výrobních, expedičních nebo logistických systémů.
2.1 Architektura řešení
Celé řešení je založeno na možnosti naplánovat vlastní automatizovaný export za předpokladu dodržení stanovených podmínek:
- předem si vybrat správný typ formátu pro export (export _format)
- připravit vlastní spouštěcí skript s autentifikací, který bude volat API rozhraní
- naplánovat automatizované spouštění na základě dohody s provozovatelem ClickEshop
2.2 API rozhraní
slouží pro automatizované zpracování XML souboru (export XML souboru s informacemi o objednávkách) při propojení ClickEshopu s jinými systémy. Na API rozhraní lze naprogramovat uživatelskou aplikaci.
Cesta k API rozhraní na automatizovaný export objednávek:
https://clickeshop.com/admin_eshop/batch/export_orders.php
XML soubor bude exportován jako komprimovaný XML soubor ve formátu ZIP
Parametry API (použití metodou HTTP POST / HTTP GET)
| Název parametru | Povinný parametr |
Popis |
| login | Ano | Postup pro vytvoření login je následující: 1) Přihlásit se do administrace daného eshopu 2) Zvolit sekci Globální nastavení - Uživatelé 3) Vyplnit "Email uživatele:" 4) Role "STANDARD" Oprávnění: žádné! 5) Uložit Na zaregistrovaný mail přijde heslo |
| password | Ano | Po vložení nového uživatele v sekci Globální nastavení - Uživatelé přijde na zaregistrovaný mail nové heslo, které se použije při autentifikaci |
| id_project | Ano | Třeba požádat podporu o přidělení ID. Požadavek musí být zaslán z kontaktního formuláře přímo z administrace eshopu (Pomoc - Zákaznická podpora) |
| stateId | Ne | Které ID stavu objednávky se májí exportovat. Standardně se exportují pouze objednávky ve stavu Nová (StateId = 1). V případě více stav se tyto oddělují středníkem např. stavy 1; 3; 8 |
| export _format | Ano | Nabývá hodnoty
_orders-yyyy-mm-dd.xml
|
2.3 Výpis zpracování dat (log)
Výsledek log ze zpracování automatického exportu bude přístupný v sekci: Globální nastavení - Hromadný import
Zaznamenán a zobrazen je vždy poslední log z exportu.
2.4 Omezení
- V reálném čase lze zpracovávat najednou pouze jeden požadavek na export
- API je možné volat maximálně 180 krát za 1 konkrétní den pro jeden projekt
- API je možné volat pouze přes šifrované spojení SSL https:
- Exportují se pouze objednávky dle stavů zasílaných jako vstupní parametry a to nejvýše 60 dní staré
(Aktuální den mínus 60 dní)
2.5 Chybové stavy
Server odpověď na output::
{"result":"ERR"} – Cyba, akce se neprovedla
{"result":"OK"} – Akce se provedla
Server odpověď v HTTP header ( HTTP Status Codes ):
200 – request success
400 – error, bad request
2.6 Vzor testovacího HTML formuláře
Pro produkční účely doporučujeme vytvořit si jednoduchou .NET aplikaci na HTTP post parametrů (kód na pár řádků). Také se dá použít open-source aplikace CURL, která se zavolá přes parametry a tato umí stáhnout komprimovaný XML soubor i s danými objednávkami ze serveru clickeshop.
1.7.1 Předpřipravený ONLINE testovací formulář
Pro testovací účely stačí pro HTTP post následující HTML formulář:
https://clickeshop.com/admin_eshop/batch/test-export_orders.html
Pro zjednodušení implementace doporučujeme podívat se na zdrojový kód HTML testovacího formuláře.
1.7.2 Příklad použití přes aplikaci CURL
Pro HTTP post (odeslání dat na server metodou POST) je možné využít open source aplikaci CURL
- stáhněte si aplikaci CURL z internetu. Do google zadejte "curl download", stáhněte a nainstalujte
- z příkazového řádku vašeho PC zavolejte následující script:
curl --http1.1 -F"login=%XXX%" -F"password=%XXX%" -F"id_project=%ID%" -F"export_format=XML-CLICKESHOP" -F"stateId=1" --output "orders.zip" https://clickeshop.com/admin_eshop/batch/export_orders.php
hodnoty %XXX% v příkazu nahraďte svými hodnotami - volání scriptu v příkazovém řádku vytvoří soubor orders.zip s objednávkami