Obecné pokyny

Ověřování

API pro správu souborů vyžadují soubor Cookie (obsahující userName, TMSESSNAME) a hlavičku X-Csrf-Token.

Endpoint	Požadavek na ověření
Všechna API pro správu souborů	Vyžadováno přihlášení, vyžadován CSRF Token
DELETE /fileManage/folder/del	Pouze Cookie, bez CSRF

Poznámka k zástupným hodnotám: V příkladech představuje {ip} IP adresu NAS a {port} port webové služby (výchozí: 5443).

Formát požadavku

• Datový formát: JSON, UTF-8
• Požadavky GET: Parametry prostřednictvím query stringu
• Požadavky POST/DELETE: Parametry v těle požadavku (JSON)
• Nahrávání souborů: multipart/form-data

Jednotný formát odpovědi

{
  "code": true,
  "code_num": 0,
  "code_msg": "",
  "msg": "",
  "data": {},
  "is_login": true,
  "time": 0.0
}

Pole	Typ	Popis
code	boolean	Příznak úspěchu požadavku: true = úspěch, false = selhání
code_num	integer	Stavový kód obchodní logiky: 0 = úspěch, nenulová hodnota = chyba
code_msg	string	Popis chybového kódu obchodní logiky
msg	string	Chybová zpráva; při úspěchu prázdná
data	object/array	Vrácená datová část
is_login	boolean	Stav přihlášení uživatele: true = přihlášen
time	number	Doba zpracování na serveru (v sekundách)

Referenční seznam chybových kódů

Následující chybové kódy obchodní logiky mohou vracet API pro správu souborů:

code_num	code_msg	Popis
0	OK	Požadavek byl úspěšný
21	invalid argument	Neplatný parametr
24	missing session	Chybějící přihlašovací údaje relace
27	account has been disabled	Účet byl zakázán
33	not empty	Zdroj není prázdný, operaci nelze provést
34	source path can not be used	Zdrojová cesta není k dispozici
35	source path already exist	Zdrojová cesta již existuje
90	permission denied	Odepřeno oprávnění
104	path does not exist	Cesta neexistuje
117	please login	Nejprve se prosím přihlaste
118	name already exists	Název již existuje
126	Read-only file system	Souborový systém je pouze pro čtení