Balíkobot
Rozšíření, které zajišťuje napojení na Balikobot, více zde.
Konfigurační soubor se standardně nachází v adresáři config/module-edeeshop/features/third-party/balikobot.xml.
Příklad konfigurace
<balikobot> <instances> <instance> <userName>balikobot_test2cztest</userName> <apiKey>someApiKey</apiKey> <code/> <eidPrefix/> </instance> </instances> <allowedShippings> <shipping> <type>PPL</type> <serviceTypes> <serviceType> <serviceType/> <shippingCode/> <shippingType/> </serviceType> </serviceTypes> </shipping> </allowedShippings> <baseApiUrl>https://api.balikobot.cz/</baseApiUrl> <catalogSpecific> <catalogCode/> <instances> <instance> <userName>balikobot_test2cztest</userName> <apiKey>someApiKey</apiKey> <code/> <eidPrefix/> </instance> </instances> <allowedShippings> <shipping> <type>PPL</type> <serviceTypes> <serviceType> <serviceType/> <shippingCode/> <shippingType/> </serviceType> </serviceTypes> </shipping> </allowedShippings> </catalogSpecific></balikobot>
Popis
balikobot
Konfigurace integrace se systémem Balíkobot.
Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| instances/instance | Seznam konfigurací pro jednotlivá napojení na Balíkobot. Standardně postačí pouze jedna instance. Pokud ale existuje více expedičních míst, je potřeba definovat v rámci Balikobotu pro každé expediční místo vlastní instanci (účet). Z tohoto důvodu je možné definovat více instancí, které lze použít pro komunikaci s Balikobotem. Každá instance je pak identifikována svým kódem. Projektově je pak možné určit, kterou instanci použít. Ve výchozím stavu se použije instance bez kódu. | List: instances/instance |
|
|
| allowedShippings/shipping | Seznam podporovaných doprav. |
|
| |
| baseApiUrl | Url, kde leží API Balíkobotu. Tuto vlastnost nelze nastavit specificky pro konkrétní katalog. Více zde. | String |
|
|
| catalogSpecific | Vlastnosti této konfigurace lze specifikovat pro konkrétní katalog. Více zde. |
|
|
instances/instance
Seznam konfigurací pro jednotlivá napojení na Balíkobot.
Standardně postačí pouze jedna instance. Pokud ale existuje více expedičních míst, je potřeba definovat v rámci Balikobotu pro každé expediční místo vlastní instanci (účet). Z tohoto důvodu je možné definovat více instancí, které lze použít pro komunikaci s Balikobotem. Každá instance je pak identifikována svým kódem.
Projektově je pak možné určit, kterou instanci použít. Ve výchozím stavu se použije instance bez kódu.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| userName | Přihlašovací jméno do Balíkobot API. Přihlašovací údaje se získají v klientské zóně – https://client.balikobot.cz) | String |
|
|
| apiKey | Přihlašovací klíč do Balíkobot API. Přihlašovací údaje se získají v klientské zóně – https://client.balikobot.cz) | String |
|
|
| code | Kód instance v případě, že je v rámci katalogu více instancí. Pokud je v rámci katalogu pouze jedna instance, je možné tento parametr vynechat. | String |
|
|
| eidPrefix | Prefix, který se odesílá jako součást eid. | String |
|
|
allowedShippings/shipping
Seznam podporovaných doprav.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| type | Typ dopravce v Balikobotu. |
Typ
|
|
|
| serviceTypes/serviceType | Seznam typů služeb daného dopravce, které se odesílají do Balikobotu v atributu Seznam je pro každého dopravce jiný, případně může být prázdný. Službu lze případně konkretizovat pro konkrétní dopravu (kód) nebo dle typu dopravy. | List: serviceTypes/serviceType |
|
|
serviceTypes/serviceType
Seznam typů služeb daného dopravce, které se odesílají do Balikobotu v atributu service_type.
Seznam je pro každého dopravce jiný, případně může být prázdný. Službu lze případně konkretizovat pro konkrétní dopravu (kód) nebo dle typu dopravy.
| Vlastnost | Popis | Hodnota | Povinná | Výchozí hodnota |
|---|---|---|---|---|
| serviceType | Kód služby dopravce. Povinná hodnota. Seznam povolených hodnot pro jednotlivé dopravy je možné získat zde: |
|
| |
| shippingCode | Kód dopravy, pro který je služba určena. Pokud je null, pak je služba určena pro všechny dopravy. | String |
|
|
| shippingType | Typ dopravy, pro který je služba určena. Pokud je |
|
|
|
serviceType
Kód služby dopravce.
Povinná hodnota.
Seznam povolených hodnot pro jednotlivé dopravy je možné získat zde:
