REST API Export kategorií produktů V1
Tento zdroj slouží k exportu dat o kategoriích produktů v Quantu. Vstupním i výstupním formátem je JSON.
Pro vytvoření a nastavení exportu použijte dialog Automatické úlohy. Po vytvoření bude v seznamu úloh ID, které předáte v URL požadavku.
ID úlohy
Nastavení
Před použitím API je nutno upravit tyto atributy v záložce Nastavení:
- Zaškrtněte atribut Zapnuto pro povolení úlohy
- V atributu Uživatelé s povoleným přístupem pro API zvolte jednoho nebo více uživatelů s rolí Robot, kteří budou mít oprávnění úlohu spouštět
- V atributu Mapování atributů kategorií produktů zvolte atributy pro export a volitelně upravte jejich JSON klíče
Atributy
Atribut | Popis | Typ |
Zapnuto | Určuje, zda je daná automatické úloha aktivní a mohou přes ní být posílána data. | ano/ne |
Název | Vlastní název automatické úlohy. | text |
Popis | Vlastní popis funkce automatické úlohy. | formátovaný text |
Poznámky | Poznámky. | dlouhý text |
E-maily pro notifikace | Jedna nebo více e-mailových adres, na které budou zasílány e-maily s chybovými stavy. | seznam řetězců |
Uživatelé s povoleným přístupem pro API | Uživatelé s rolí Robot, kteří jsou oprávněni úlohu spouštět. | seznam uživatelů |
Zpoždění v sekundách před opakováním | V případě stavového kódu 503 se má klient znovu pokusit poslat požadavek za tolik sekund. | číslo |
Mapování atributů kategorií produktů | Mapování obsahující položku pro každý exportovaný atribut produktu nebo kategorie | komplexní typ |
Samostatné řádky pro kategorie | Mapování obsahující položku pro každý atribut umístěného produktu, který má být exportován | ano/ne |
Jednotka rozměru | Měrná jednotka jako cm, mm atd. | výběr |
Formát dat | Formát zápisu data, např. 31.12.19 | výběr |
Formát datumu a času | Formát zápisu data a času, např. 31.12.19 23:59:59 | výběr |
Oddělovač položek seznamu | Znak pro rozdělení položek seznamu hodnot. | znak |
Sada produktů | Filtr určující seznam produktů pro export. | komplexní typ |
Požadavek
/v1/export/product-categories/{id_ulohy}
Parametr | Hodnota |
URL | ?debug přidaný do URL zobrazí v odpovědi i varování. Bez toho se vypisují pouze chyby. |
Hlavička | Accept: application/json |
Hlavička | Content-type: application/json |
Hlavička | Authorization: Bearer <TOKEN> TOKEN se získává pomocí /authenticate (viz. Přihlášení). |
Metoda | POST |
Odpověď
Klíč | Hodnota |
Status | Řetězec popisující výsledný stav exportu.
|
Warnings | Volitelný - je zahrnut pouze, pokud je v URL parametr ?debug a export vygeneroval alespoň jedno varování. Seznam řetězců s varováními. |
Errors | Volitelný - je zahrnut pouze, pokud export vygeneroval alespoň jedno chybu. Seznam řetězců s chybami. |
Records | Volitelný - je zahrnut pouze, pokud export neskončil se stavem "FAILURE". Seznam exportovaných objektů. Každý objekt obsahuje klíče definované mapováním v nastavení úlohy. |
Stavové kódy
Stav | Význam |
200 OK | Export proběhl úspěšně s výsledným stavem "SUCCESS" nebo "PARTIAL_SUCCESS". Odpověď může obsahovat varování nebo nezávažné chyby. |
400 Bad Request | Chybné nastavení úlohy nebo chybný požadavek. |
401 Unauthorized | Autorizační token je neplatný, nebo uživatel, který je tokenem přihlášen, nemá oprávnění spouštět tuto úlohu. |
404 Not Found | Nebyla nalezena úloha s ID daným v URL. |
500 Internal Server Error | Během exportu nastala kritická chyba na straně serveru. |
503 Service Unavailable | Fronta čekajících požadavků je plná, nový požadavek se již nepřidá a klient dostane instrukci, aby znovu poslal požadavek za X sekund (pro X viz. nastavení „Zpoždění v sekundách před opakováním“). |
Záznam průběhu
V Quantu vedle nastavení úlohy lze prohlížet i záznamy průběhů jednotlivých exportů, včetně statistik, chyb a varování.
Vybereme-li konkrétní záznam, můžeme zobrazit jeho detaily tlačítkem Zobrazit položky.
Požadavek
curl -X POST --location "http://[VASE_SPOLECNOST].iquant.eu/v1/export/product-categories/246?debug" \
-H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '{}'
- Odpověď typu „samostatné řádky“:
{
"Status": "SUCCESS", "Records": [
{
"QID Produktu": "400020",
"Primární Id": "10039",
"ID kategorie": "CAT203"
},
{
"QID Produktu": "400020",
"Primární Id": "10039",
"ID kategorie": "CAT3"
},
...
]}
- Odpověď typu „kumulované řádky“:
{
"Status": "SUCCESS", "Records": [
{
"QID Produktu": "400020",
"Primární Id": "10039",
"ID kategorie": [
"CAT203",
"CAT3"
]
}, {
"QID Produktu": "400021",
"Primární Id": "10040",
"ID kategorie": [
"CAT8",
"CAT12",
"CAT55",
"CAT112"
]
},
...
]}