Přejít na hlavní obsah

​
O co jde

Shops API je určené pro provozovatele e-shopových platforem (nikoliv jednotlivé obchody), kteří chtějí svým klientům nabídnout oficiální napojení na Base.com. Na rozdíl od hlavního API zde nevoláte Base.com — naopak Base.com volá váš integrační soubor, umístěný na vašem serveru.

​
Princip

  1. Na vašem serveru vytvoříte veřejně dostupný skript (obvykle PHP, ale jazyk je libovolný), který přijímá POST požadavky s parametrem action (název volané funkce) a bl_pass (komunikační klíč vygenerovaný v panelu Base.com).
  2. Base.com k vám žádná hesla ani přístupy do databáze neposílá ani nevyžaduje — komunikace je zabezpečená pouze náhodně vygenerovaným klíčem.
  3. Výsledky vždy vracíte jako JSON v UTF-8.

​
Povinné metody

Bez těchto dvou metod integraci nelze spustit:
  • SupportedMethods — seznam všech funkcí, které váš integrační soubor podporuje.
  • FileVersion — verze integračního souboru.

​
Doporučené pořadí implementace

  1. SupportedMethods, FileVersion — základ, bez kterého se integrace neověří.
  2. ProductsCategories, ProductsList, ProductsData — čtení katalogu.
  3. ProductsPrices, ProductsQuantity — ceny a dostupnost.
  4. OrdersGet, StatusesList, DeliveryMethodsList, PaymentMethodsList — čtení objednávek a číselníků.
  5. OrderAdd, OrderUpdate — zápis objednávek zpět do vaší platformy.
  6. Volitelně ProductAdd, CategoryAdd, ProductsQuantityUpdate, ProductsPriceUpdate pro obousměrnou správu katalogu.
Kompletní popis parametrů a formátu odpovědí pro každou metodu najdete v dokumentaci Shops API.

​
Stránkování

Pokud metoda (typicky ProductsList, ProductsQuantity, ProductsPrices) může vracet velký objem dat, vraťte v odpovědi pole pages s celkovým počtem stránek. Base.com si následně vyžádá stránky 2 až N parametrem page.
Pokud plánujete nabídnout integraci širšímu okruhu klientů (partnerský program), doporučujeme před spuštěním do produkce projít implementaci s naším implementačním oddělením — ověří kompletnost i výkon integračního souboru.