REST API Export analýz

Tento zdroj slouží k exportu analýz v Quantu. Můžete exportovat analýzu Příležitosti kategorií nebo Přehled vybavení. Vstupním i výstupním formátem je JSON.

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.
  • V atributu Analyzovat zvolte analýzu, jež požadujete exportovat.
  • V atributu Mapování atributů analýzy příležitostí / přehledu vybavení 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
Nadpis
Vlastní název automatické úlohy.
text
Popis
Vlastní popis funkce automatické úlohy.
formátovaný text
Poznámky
Poznámky.
dlouhý text
E-maily k notifikacím

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ždení 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ů analýzy příležitostí
Mapování obsahující položku pro každý atribut vybavení, který má být exportován.
komplexní typ
Mapování atributů přehledu vybavení
Mapování obsahující položku pro každý atribut vybavení, který má být exportován.
komplexní typ
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 oddělující jednotlivé položky v seznamu.
výběr
Analyzovat
Výběr analýzy.
seznam analýz
Kritéria analýzy
Výběr nastavení kritérií, podle kterých se má analýza exportovat.
komplexní typ
Nastavení a důležité atributy
  • Požadavek

/v1/export/analyze-report/{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 (volitelná)
Accept-Encoding: gzip
Hlavička

Authorization: Bearer  <TOKEN>

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

Metoda
POST

Obsahem požadavku analýzy Přehled vybavení je JSON objekt obsahující tyto klíče:

Klíč
Hodnota
StoreIds
V rámci požadavku je potřeba uvést pro jakou pobočku se mají produktové údaje exportovat. Vždy je možné zvolit pouze jednu pobočku. 
Příklady:
{ "StoreIds": "12"}
  • Odpověď
Klíč
Hodnota
Status
Řetězec popisující výsledný stav exportu.
  • SUCCESS = bezchybný průběh exportu
  • PARTIAL_SUCCESS = export proběhl, ale vygeneroval jedno nebo více varování
  • FAILURE = při exportu nastala jedna nebo více chyb
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

Export již běží. Zkuste to spustit znova za počet sekund udávaných v hlavičce Retry-After.

  • 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í.

Záznam průběhu

Vybereme-li konkrétní záznam, můžeme zobrazit jeho detaily tlačítkem Zobrazit položky.

Zobrazení položek průběhu


  • Požadavek pro Příležitosti kategorií

curl -X POST --location "http://[VASE_SPOLECNOST].iquant.eu/v1/export/analyze-report/117131?debug" \

    -H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \

    -H "Accept: application/json" \

    -H "Content-Type: application/json" \

    -H "Cache-Control: no-cache" \

  • Požadavek pro Přehled vybavení

curl -X POST --location "http://[VASE_SPOLECNOST].iquant.eu/v1/export/analyze-report/117131?debug" \

    -H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \

    -H "Accept: application/json" \

    -H "Content-Type: application/json" \

    -H "Cache-Control: no-cache" \

-d '[{ "StoreID": "12564"}]'

  • Odpověď

{

  "Status": "SUCCESS", "Records": [

  {"ID pobočky": "234", "Název pobočky": "Kutná Hora", "Město": "Kutná Hora", "Typ vybavení": "Freezer", "Počet polic": "5", "Kategorie": "Doplňky", "ID Kategorie": "CAT6"},

  {"ID pobočky": "238", "Název pobočky": "Ostrava - Svinov", "Město": "Ostrava", "Typ vybavení": "Default", "Počet polic": "6", "Kategorie": "Yoga", "ID Kategorie": "CAT931"},

  {"ID pobočky": "545", "Název pobočky": "Kolín", "Město": "Kolín", "Typ vybavení": "Default", "Počet polic": "6", "Kategorie": "Mléka", "ID Kategorie": "CAT14"},

  ... ]

}