Základní informace pro partnery
Rozhraní pro platební metodu HC On-line je REST API, kde se pro veškerou komunikaci (dotazy - requesty a odpovědi - response) a popis dat využívá notace JSON.
Přehled integrace
Implementace je o čtyřech krocích. U každého kroku si můžete zvolit variantu, která vám nejlépe vyhovuje—od plné kontroly přes API po minimální integraci.
1
📊
Kalkulačka
2
🛒
Vytvoření žádosti
3
🔔
Notifikace
4
📦
Vyskladnění a doručení
1. 📊 Kalkulačka v detailu produktu
Umožněte zákazníkům zobrazit možnosti splátek na stránce produktu. Vyberte jednu ze tří variant:
| Varianta | Popis | Odkaz |
|---|---|---|
| API | Vlastní design, my vracíme hodnoty. Pouze pro certifikované zprostředkovatele dle zákona 257/2016 Sb. | PSP - Zdroje pro výpočet splátek - eshop - Zdroje pro výpočet splátek |
| Widget | JavaScriptový widget do stránek vašeho e-shopu (stáhněte zde). Pouze pro certifikované zprostředkovatele dle zákona 257/2016 Sb. | JavaScript widget integration |
| Standalone | „Pouze odkaz“ k nám—otevře naši kalkulačku v novém okně nebo záložce. | Standalone |
2. 🛒 Vytvoření žádosti (Create application)
Vytvoření žádosti přes API a přesměrování klienta k nám k doplnění žádosti.
- Autentizace: PSP: Login partner - eshop: Login partner (
authentication/v1/partner) - Vytvoření žádosti: PSP: Create application (
financing/v3/applications) - eshop: Create application (financing/v1/applications) - Přesměrujte zákazníka na
gatewayRedirectUrlvrácené v odpovědi, aby mohl žádost dokončit u nás.
3. 🔔 Notifikace
Mějte přehled o stavu žádosti. Vyberte jednu ze tří variant:
| Varianta | Popis | Odkaz |
|---|---|---|
| Notifikační endpoint | Zasíláme na vaše API při každé změně žádosti. | PSP: Application notification - eshop: Application notification |
| Webservice | Přes API odpovíme na váš dotaz aktuálním stavem žádosti („GET applicationDetail“). | PSP: Get application - eshop: Get application |
| Webclient + email | Ruční potvrzení po přihlášení do webové aplikace doplněné emailem. | — |
4. 📦 Potvrzení vyskladnění nebo doručení
Potvrďte odeslání a případně doručení zboží. Vyberte způsob hlášení:
| Varianta | Popis | Odkaz |
|---|---|---|
| Mark as shipped | Potvrzení odeslání zboží přes API. | PSP: Mark order as shipped - eshop: Mark order as shipped |
| Mark as delivered | Potvrzení o doručení zboží klientovi přes API. | PSP: Mark order as delivered - eshop: Mark order as delivered |
| Webclient | Ruční potvrzení po přihlášení do webové aplikace. | — |
Odkazy a další informace
- Technická dokumentace k API (dále TD) a základní popis fungování platební metody je k nalezení na zde
- Veřejně přístupná repository s podkladovými daty je k dispozici na https://github.com/homecreditcz, najdete zde:
- Tuto příručku k veřejnému API včetně návodů a vzorových dat
- Kalkulačku splátek ve formě javascriptového widgetu (widget-calculator)
- PHP skript obstarávající základní funkcionalitu nezbytnou pro integraci HC platby na váš e-shop (php-script)
- PHP knihovnu obstarávající základní funkcionalitu nezbytnou pro integraci HC platby na váš e-shop (oneclick-api-client) - POZOR - ZASTARALÉ - pouze pro PHP 5.6!!!