Import produktů přes API

Produkty lze programově importovat přes rozhraní API (Application Programming Interface) s využitím zabezpečeného protokolu HTTPS.

Pro import produktu přes API je třeba provést následující kroky:

  1. Získat přístupový token
  2. Importovat produkt s připojeným přístupovým tokenem

V tomto příkladu bude pro provádění HTTPS dotazů použit nástroj POSTMAN.

Získání přístupového tokenu

Nejprve je nutné získat přístupový token, aby bylo možné spravovat aplikační data uživatele.
Získání tokenu lze provést pomocí POST požadavku na endpoint /api/v1/auth/login a zadáním parametrů uživatelského jména a hesla v těle JSON požadavku.

Přístupový token bude vrácen jako součást odpovědi. Tento token lze použít pro přístup k endpointům, které umožňují správu uživatelských dat.

Import produktu

Produkt lze vytvořit pomocí POST požadavku na endpoint /api/v1/products/create.

Pro vytvoření jednoduchého produktu je třeba poskytnout následující atributy:

Jak již bylo zmíněno, přístupový token musí být připojen jako součást hlavičky ve tvaru "Authorization: bearer <AUTH_TOKEN>", aby bylo možné aktualizovat uživatelská data.

V POSTMANu to lze provést následujícím způsobem:

Zobrazení produktu na produktovém dashboardu

Pokud byl požadavek úspěšně proveden, produkt se zobrazí na produktovém dashboardu.

Všechny možné atributy produktu

Parametr Popis
at_subcontractor Boolean určující, že produkt je aktuálně u subdodavatele.
color Hex kód definující barvu karty na produktovém dashboardu. (použijte naši paletu OFFISEEK).
customer_name Jméno zákazníka.
delivery_date Předpokládané datum dodání produktu zákazníkem.
description Textový popis produktu.
exchange_rate Pokud se měna výrobní a prodejní ceny liší, je nutné uložit aktuální směnný kurz.
has_prepayment Boolean určující, zda zákazník musí za produkt zaplatit předem.
has_transport Boolean určující, zda je továrna zodpovědná za přepravu zboží.
name Název produktu.
note Poznámka, např. pro přepravu zboží.
order Pozice karty produktu ve sloupci stavu na produktovém dashboardu.
order_id ID objednávky z externího ERP nebo účetního systému.
production_date Předpokládané datum výroby produktu.
production_price Výrobní cena.
production_price_currency Měna výrobní ceny.
production_unit_price Výrobní jednotková cena.
quantity Kvantita - může být textová.
sale_price Prodejní cena.
sale_price_currency Měna prodejní ceny.
sale_unit_price Prodejní jednotková cena.
status Stav produktu - "new" / "todo" / "inprogress" / "done".
to_stock Boolean určující, zda je produkt vyráběn na sklad.
Vyzkoušejte Free Trial