REST Import fotek implementace

Tento zdroj slouží k importu implementačních fotek do Quantu jako jednoho obrázkového souboru.

Tento zdroj slouží k importu implementačních fotek vybavení do Quantu. Vstupem je jeden obrázkový soubor. Každý import přidá k vybavení novou fotku. Existující fotky se nepřepisují. Fotky importované přes API nemají autora. Importovaná fotka se zobrazí v Quant Webu (v sekcích Implementační fotky, Nedávné fotky a Fotky prodejen) a v Quant Desktopu.

K vytvoření a nastavení importu použijte sekci Automatické úlohy. Po vytvoření bude mít úloha v seznamu ID, které se předává v URL požadavku.

Automatické úlohy

  • Nastavení

Před použitím API je nutné upravit následující atributy na záložce Nastavení:

  • Zaškrtněte atribut Zapnuto, čímž úlohu aktivujete.
  • V poli Uživatelé s povoleným přístupem pro API vyberte jednoho nebo více uživatelů s rolí Robot, kteří budou mít oprávnění úlohu spouštět.
  • Atributy  
Atribut
Popis
Typ
Povoleno
Určuje, zda má uživatel přístup k tomuto zdroji.
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
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
Počet sekund, které má klient počkat před opakováním importu v případě dlouhé fronty požadavků na serveru.
celé číslo


Nstavení
  • Požadavek
Parametr
Hodnota
URL
/v1/import/implementation-photo/{task_id}
Debug
Přidáním ?debug=true do URL se v odpovědi zobrazí i upozornění (warning). Bez něj se vypisují pouze chyby
Hlavička
Content-Type: application/octet-stream
Hlavička

Authorization: Bearer  <TOKEN>

TOKEN se získává přes / authenticate (viz Přihlášení).

Metoda
POST
Tělo

Binární obsah obrázku. V jednom požadavku lze odeslat pouze jeden obrázek.

  • URL parametry
Parametr
Description
Typ
Required
StoreOid
OID prodejny v Quantu.
  číslo  ano
ComponentId
UUID vybavení.
  řetězec  ano
categoryOid
OID kategorie. 
  číslo  podmíněně

Kdy použít categoryOid:
Povinný: Pokud je planogram rozdělen do více kategorií, je nutné uvést categoryOid pro určení kategorie.
Neuvádět: Pokud má planogram pouze jednu kategorii, categoryOid v požadavku neposílejte.

  • Stavové kódy
Status
Význam
200 OK
Fotka byla importována.
400 Bad Request
Chybný požadavek, například chybějící nebo neplatný parametr, chybějící categoryOid nebo chybějící obrázek.
401 Unauthorized
Autorizační token je neplatný, nebo uživatel přihlášený pomocí tokenu nemá oprávnění používat API.
404 Not Found
Prodejna nebo vybavení se zadaným ID nebylo nalezeno.
  • Poslední logy

V Quantu lze kromě nastavení úlohy zobrazit také záznamy jednotlivých importů, včetně statistik, chyb a upozornění.

Detail konkrétního záznamu zobrazíte jeho výběrem a kliknutím na tlačítko Stáhnout soubory.
Detaily záznamu

  • Požadavek (příklad)

curl -X POST --location “https://[YOUR_COMPANY].iquant.eu/v1/import/implementation-photo?{{TaskIDImportImplPhoto}}?debug=true&storeOid=169&componentId=123e4567-e89b-12d3-a456-426614174000&categoryOid=742&debug” 
-H “Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n” 
-H “Content-Type: application/octet-stream” 
--data-binary “@photo.jpg”

  • Odpověď 

{ "Status": "SUCCESS" }