Servisní portál API pro předávání stavu požadavků
Datová výměna s autorizovanými servisy
Introduction
Následující text popisuje možnosti datového propojení Alzy s autorizovanými servisy.
Historie dokumentu
| Verze | Popis | Datum | Autor |
|---|---|---|---|
1.5 |
Revize dokumentace, převod do online podoby | 1.5.2020 | Jiří Diviš |
1.6 |
Příklady úpravy SET dle způsobu vyřízení | 5.5.2020 | Jiří Diviš |
1.7 |
Oprava názvu a URL sign-in metody | 12.5.2020 | Jiří Diviš |
1.8 |
Přidání polí ProductCode, ProductSupplierCode, ProductPN, ProductEAN | 27.5.2020 | Jiří Diviš |
1.9 |
Přidání polí warrantyClaimReceipt, acceptedDate, isDamaged | 1.8.2020 | Jiří Diviš |
1.10 |
Oprava příkladu v případě vyřízení reklamace dobropisem | 6.5.2021 | Jiří Diviš |
1.11 |
Přidání polí productVisualState, customerName, customerEmail, customerTelephoneNumber | 6.5.2021 | Jiří Diviš |
1.12 |
Změna URL služby | 18.8.2025 | Jiří Diviš |
1.13 |
Podporované formáty datumů | 19.8.2025 | Jiří Diviš |
Datové propojení
Datové propojení je realizováno pomocí veřejně přístupného REST API, které poskytuje metody pro zobrazení a práci s daty servisu. Jako formát výměny dat byl zvolen standardní fromát JSON. Servis dostane k dispozici autorizační token, pomocí kterého může API bezpečně dotazovat. Mezi daty služby a daty v produkčním systému Alzy dochází k přísně kontrolované výměně validních stavů. Proto po importu dat do interního systému nemusí vždy dojít k synchronizaci s informačním systémem (v případě vložení porušených nebo nesmyslných kombinací dat). Všechny anomálie na vstupu a při zpracování dat logujeme a spolupracujeme se servisy, aby výměna probíhala bez problémů.
Komunikační protokol
-
Je vyžadován důvěryhodný
HTTPSověřovací certifikát. -
Je vyžadován
TLSprotokol verze 1.2 nebo vyšší. -
Všechny žádosti-requesty musí používat
Content-Type: application/jsonhlavičku spolu sUTF-8znakovou sadou (RFC 7231, section 3.1.1.5: Content-Type) -
Všechny žádosti-requesty musí mít vyplněnou hlavičku
User-Agent(RFC 7231, section 5.5.3: User-Agent)
Připojení
Tst prostředí
- Veřejná adresa služby (REST API): https://service-center-connector-test.alza.cz/
- Swagger dokumentace: https://service-center-connector-test.alza.cz/swagger
Prd prostředí
- Veřejná adresa služby (REST API): https://service-center-connector.alza.cz/
Na produkčním prostředí není Swagger dokumentace dostupná. Popisy request/response polí a datových struktur jsou k dispozici pouze na tst prostředí (viz výše).
Princip zpracování servisních požadavků
Servisní požadavek
Základní entitou, nad kterou probíhá komunikace, je servisní požadavek, v dokumentaci service task. Servisní požadavek je určen v systémech Alzy jednoznačným identifikátorem ve formátu SETxyz, kde xyz je celé číslo a slouží ke zpracování servisního případu ve směru Alza ↔ autorizovaný servis. Na druhou stranu záznam reklamace slouží pouze ke komunikaci se zákazníkem a reflektuje zákonnou povinnost. Servisní požadavek je také obvykle obsahem zásilky, kterou se dostává zboží z poboček do reklamační centrály nebo do servisu. V záznamu evidujeme množství údajů, část z nich je společná a datově shodná s údaji v autorizovaných servisních centrech. Pro pohodlný přístup k záznamu lze servisní požadavek dotazovat pomocí externího identifikátoru externalServiceTaskKey, který je možné k záznamu uložit.
Servisní soupiska
Servisní soupiska, v dokumentaci vendor sheet, slouží k seskupení servisních požadavků do jedné zásilky a odeslání do servisu. V cílovém servisu obvykle slouží ke kontrole obsahu zásilky.
Životní cyklus servisního požadavku v Alze
| Stav číselně | Stav text | Umístění | Význam |
|---|---|---|---|
| 0 | Nový | Alza - pobočka | vznik při příjmu zboží od zákazníka do procesu reklamace |
| 10 | Odesláno z pobočky na centrálu | Alza - dopravce | fyzické odeslání zboží z pobočky na reklamační centrálu Alzy |
| 15 | Přijato z pobočky na centrále | Alza - reklamační centrála | přejímka zboží z pobočky na reklamační centrále |
| 20 | Připraveno k odeslání | Alza - reklamační centrála | distribuce nastaveným autorizovaným servisům dle vlastností zboží (výrobce, SEO prefix, segment apod.) |
| 30 | Odesláno dodavateli | Servis - dopravce | zboží bylo předáno dopravci nebo samosvozci |
| 35 | Přijatá zásilka od dodavatele | Alza - reklamační centrála | přejímka zboží ze servisu na reklamační centrále - po rozbalení zásilky je identifikován servisní případ dle čísla SET |
| 40 | Přijato od dodavatele | Alza - reklamační centrála | proběhlo fyzické zpracování servisního případu technikem, přičemž je určen způsob vyřízení včetně detailního report dle přiloženého protokolu |
| 50 | Vyřízeno | Alza - reklamační centrála | dle způsobu vyřízení servisního případu je vyřízena zákaznická reklamace |
| 100 | Ukončeno | Alza - zákazník/sklad | servisní řízení je ukončeno a zboží již předáváme zákazníkovi / na sklad / případně se zakládá nový servisní požadavek |
Postup vyřízení servisního požadavku
Řešení servisního požadavku OPRAVOU
- Vznik servisního požadavku na pobočce a odeslání do reklamační centrály Alzy
- Určení autorizovaného servisu dle typu zboží a odeslání do servisu současně se servisní soupiskou
- Servis v případě dokončení servisního případu provolá metodu pro úprava dat konkrétního servisního případu a vyplní identifikátor servisního případu + způsob vyřízení
solution.REPAIREDa servisní reportserviceReport. - Ve chvíli odeslání servis provolá stejnou metodu a uvede hodnotu pro číslo zásilky
returnPackageNumber, pod kterou k nám servisní požadavek dorazí. - Po doručení zásilky do Alzy přijímací technik fyzicky kontroluje zboží
- V systému se mu automaticky dotahují data předaná pomocí API rozhraní
- Dotažená data technik pouze zkontroluje a na jejich základě vyřizuje reklamaci
-
Tímto je servisní případ ukončen
- Pokud dojde ke změně SN/IMEI zapíše do atributu
replacedSerialNumber
- Pokud dojde ke změně SN/IMEI zapíše do atributu
Řešení servisního požadavku VÝMĚNOU
-
Postup je podobný řešení opravou.
-
Rozdíl je ve způsobu vyřízení
solution.REPLACEMENTa odeslaném novém SN nebo IMEI v atributureplacedSerialNumber -
Pokud dojde k výměně za odlišný produkt (novější verzi, podobné zařízení ve stejné nebo vyšší cenové kategorii) je potřeba navíc vyplnit strukturu
replacedProduct. Povinná pole pak jsousupplierCode,EAN,Name.
Řešení servisního požadavku ZAMÍTNUTÍM
-
Postup je podobný řešení opravou
-
Autorizovaný servis posílá způsob vyřízení jako
solution.REJECTEDa navíc detailní důvod zamítnutírejectedDetail
Řešení servisního požadavku PROTOKOLEM O NEOPRAVITELNOSTI
-
Autorizovaný servis posílá způsob vyřízení jako
solution.UNRECOVERABLE_PROTOCOL -
Pokud servis není zároveň dodavatelem odesílá flag protokol neopravitelnosti
unrecoverableProtocolDetail, kterým říká, zda-li odesílá včetně protokolu i zboží. Pokud ano, je potřeba při expedici zároveň vypnitreturnPackageNumberjako při řešení opravou.
Řešení servisního požadavku DOBROPISEM
-
Autorizovaný servis posílá způsob vyřízení jako
solution.CREDIT_NOTE -
Dokladová výměna dobropisů proběhne v EDI → dobropis od dodavatele Reklamace
Odeslání cenového návrhu
Je obvyklé posílat CN automaticky při vyřízení zamítnutím
-
Pro odeslání CN se používá sekce
priceProposal -
V případě CN čeká servis dohodnutou dobu než zboží odesílá zpátky na vyjádření reklamační centrály
- V budoucnu bude automatizováno a součástí rozhraní
-
Synchronizace objednávky CN proběhne v EDI → objednávka na Servisní opravy
-
Synchronizace daňových dokladů proběhne v EDI → přijatá faktura od dodavatele na Servisní opravy
Reference
API metody pro komunikaci s autorizovanými servisy. Popisy request/response polí a datových struktur jsou k dispozici ve sekci Připojení (tst prostředí).
Autorizace - získání tokenu
Autorizace je stejná pro všechny API metody. K autorizaci je třeba access token, vygenerovaný dotazem na sign-in service endpoint. Platnost tokenu je 60 minut, doporučuje se token generovat před každým dotazem či dávkou. Pro autorizaci jsou nutné přihlašovací údaje (username, password). Přihlašovací údaje zašle Alza, jsou stejné jak pro testovací, tak pro produkční prostředí. Povinný parametr autorizace clientId se vždy plní konstantou external_client_authorized_service.
/sign-inDotazování seznamu servisních požadavků
Vrací seznam servisních požadavků dle zadaného filtru. V případě, že kritériím neodpovídá žádný požadavek, vrátí se prázdný seznam.
/authorized-services/service-tasks/v1/Dotazování jednoho servisního požadavku
Vrací jeden konkrétní servisní požadavek dle interního či externího identifikátoru (vždy jedno z polí serviceTaskKey či externalServiceTaskKey je povinné). Pokud pro zadaný identifikátor není nalezen žádný požadavek, response body je prázdný.
/authorized-services/service-task/v1/Úprava jednoho servisního případu
Aktualizuje data servisního požadavku dle interního či externího identifikátoru. Metoda podporuje různé způsoby vyřízení (oprava, výměna, zamítnutí, protokol o neopravitelnosti, dobropis).
/authorized-services/update-service-task/v1/

