REST API Import poboček V1

Tento zdroj slouží k importu dat poboček v Quantu. Vstupním i výstupním formátem je JSON.

Pro vytvoření a nastavení importu použijte pohled Automatické úlohy. Po vytvoření bude v seznamu úloh ID, které předáte v URL požadavku.

Automatická úloha REST Import dat poboček
  • 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ů dat poboček zvolte atributy pro import 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
Emaily 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ždění v sekundách před opakováním
Počet sekund, jak dlouho má čekat klient, než znovu zkusí provést import v případě dlouhé kolony požadavků na serveru.
celé číslo
Mapování atributů dat poboček
Mapování obsahující položku pro každý atribut, který má být importová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 pro hodnoty typu seznam.
výběr

  • Požadavek

/v1/import/store-data/{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

Obsahem požadavku je pole JSON objektů obsahující klíče definované v nastavení Mapování atributů dat poboček

  • Odpověď
Klíč
Hodnota
Status
Řetězec popisující výsledný stav importu.
  • SUCCESS = bezchybný průběh importu
  • PARTIAL_SUCCESS = import proběhl, ale vygeneroval jedno nebo více varování
  • FAILURE = při importu nastala jedna nebo více chyb
Warnings
Je volitelný, tzn. je zahrnut pouze, pokud je v URL parametr ?debug a import vygeneroval alespoň jedno varování.
Seznam řetězců s varováními.
Errors
Volitelný - je zahrnut pouze, pokud import vygeneroval alespoň jednu chybu.
Seznam řetězců s varováními.
Total Lines
Volitelný - je zahrnut pouze, pokud import neskončil se stavem "FAILURE"
Počet záznamů na vstupu.
Empty IDs
Počet záznamů s prázdnou hodnotou ID pobočky
Stores Duplicated
Volitelný - Je zahrnut pouze, pokud import neskončil se stavem "FAILURE"
Počet záznamů, které byly přeskočeny, protože odkazují na pobočku, která již byla importována v jiném záznamu.
  • Stavové kódy
Stav
Význam
200 OK
Import proběhl úspěšně s výsledným stavem "SUCCESS" nebo "PARTIAL_SUCCESS". Odpověď může obsahovat varování.
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 importu nastala kritická chyba na straně serveru.

503 Service Unavailable 

Import již běží. Zaplnila se fronta pro tento import. Zkuste spustit znovu 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 importů, 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.

Detaily záznamu


  • Požadavek

curl -X POST --location "https://[VASE_SPOLECNOST].iquant.eu/v1/import/store-data/159?debug" \

    -H "Authorization: Bearer ywJqq25pXO6oaCPqgEAiTioBVwM8Ih2kOwzzd3eWK3R2oDSA5n" \

    -H "Accept: application/json" \

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

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

-d '[{ "Store ID": "100001", "Store Name": "Test Store" }]'


  • Odpověď

{

  "Status": "SUCCESS", 

  "Total Lines": 1,

  "Empty IDs": 0,

  "Stores Duplicated": 0

}