REST API Export produktových obrázků
Tento zdroj slouží k exportu dat s produktovými obrázky z Quantu. Vstupním formátem je JSON a výstupním formátem je octet-stream.
Pro vytvoření a nastavení exportu použijte sekci Automatické úlohy. Po vytvoření bude v seznamu úloh ID, které předáte v URL požadavku.
Automatická úloha
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.
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 |
Nadpis | Vlastní název automatické úlohy. | text |
Popis | Vlastní popis funkce automatické úlohy. | formátovaný text |
Poznámky | Poznámka. | dlouhý text |
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 za tento počet sekund znovu pokusit poslat požadavek. | číslo |
Párovací atribut | Podle jakého párovacího atributu mají být data exportována, např. Primární Id produktu nebo Název. | komplexní typ |
Požadavek
/v1/export/product-image/{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/octet-stream |
Hlavička | Content-type: application/json |
Hlavička | Authorization: Bearer <TOKEN> TOKEN se získává pomocí /authenticate (viz. Přihlášení). |
Metoda | POST |
Obsahem požadavku je JSON objekt obsahující tyto klíče:
Klíč | Hodnota |
ProductId | V rámci požadavku je potřeba uvést pro jaký produkt se má obrázek exportovat. V nastavení úlohy v řádku Párovací atribut si můžete vybrat jaký párovací atribut budete v rámci požadavku pod hodnotou "ProductId" posílat. Vždy je možné zvolit pouze jeden produkt. . Příklad: { "ProductId": "10001"} |
Odpověď
Odpověď vrátí přední obrázek výchozího balení produktu ve formátu octet-stream. Pokud je shoda s ProductId ve více produktech, pošle se jeden náhodně poslaný obrázek odpovídajícího produktu. V případě, že si požadujete produkt prohlédnout je potřeba odpověď stáhnout a uložit do formátu .png a .jpg.
Stavové kódy
Stav | Význam |
200 OK | Export proběhl úspěšně. Obrázek produktu byl vrácen. |
204 No Content | Produkt v Quantu neexistuje nebo k němu neexistuje obrázek. |
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. |
Nejnovější logy
V Quantu si lze kromě nastavení úlohy prohlížet i záznamy průběhů jednotlivých exportů, včetně statistik, chyb a varování.
Vybereme-li konkrétní záznam v záložce Nejnovější logy, můžeme si zobrazit jeho případné chyby a varování.
Požadavek
curl -X POST --location "http://localhost:4150/v1/export/product-image/1076664" \
-H "Authorization: Bearer <API_TOKEN>" \
-H "Accept: application/octet-stream" \
-H "Content-Type: application/json" \
-H "Cache-Control: no-cache" \
-d '{ \"ProductId\": \"100001\"}'
Odpověď
{
����JFIF��C %# , #&')*)-0-(0%()(��C (((((((((((((((((((((((((((((((((((((((((((((((((((�� �"�� ���}!1AQa"q2���#B��R��$3br� %&'()*456789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz��������������������������������������������������������������������������� ���w!1AQaq"2�B���� #3R�br� $4�%�&'()*56789:CDEFGHIJSTUVWXYZcdefghijstuvwxyz�������������������������������������������������������������������������� ?���(��(��(��(��(��(��(��(��(��(��(��(��(��(��(��(��(��(��(��(��(��(��(��(��
...
}