Po dokončení nastavení potřebujeme jednoduše vyzkoušet, zda je Web API funkční. WebAPI Server naslouchá na portu 699. Požadavek vrátí Objekt informací o systému obsahující informace o nainstalované verzi a pole obsahující Objekty spojení. Každý Objekt spojení obsahuje název spojení a také alias, je-li nadefinován. Prostřednictvím Content negotiation (hlavička Accept) můžeme výsledek získat jako HTML tabulku nebo JSON objekt.

GET http://localhost:699/

Příklad výsledku: Status 200 OK

{
	"version": "23.2.0, linie 7",
	"major_version": 23,
	"minor_version": 2,
	"connections": [
		{
			"name": "Demo",
			"alias": "D",
			"state": "OK",
			"islocked": false,
			"isexclusivelock": false,
			"ismain": true
								
																								
		}
	]
}

Dotaz na vrácení (GET) kolekce faktur vydaných (pozor, není aplikováno omezení, v závislosti na počtu faktur může brzdit server).

GET http://localhost/data/issuedinvoices HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Dotaz na vrácení (GET) jedné faktury vydané s ID=1400000101

GET http://localhost/data/issuedinvoices/1400000101 HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Získání kolekce řádků faktur vydaných (subkolekce řádků FV má název "rows"):

GET http://localhost/data/issuedinvoices/1400000101/rows HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Validace založení skladové karty s parametrem validation=true

POST http://localhost/data/Storecards?select=ID,name&expand=country_id(id,code)&validation=true HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Tělo požadavku:

{
	"name": "testcard"
}
						

Pomocí query parametrů select a expand byly vráceny pouze požadované položky. Oproti normálnímu dotazu obsahuje odpověď ještě klíč @meta s meta informacemi validace zakládané skladové karty. V části errors jsou zapsány kritické chyby, kvůli kterým nelze skladovou kartu založit. Oproti tomu warnings jsou jen doporučení, co by bylo dobré nastavit, ale není to nutné pro úspěšné provedení dotazu a založené skladové karty.

Dotaz do databáze ARES na firmu "abra" s vráceným názvem firmy a IČ.

POST http://localhost/data/firms/register?select=Name, OrgIdentNumber HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Tělo požadavku:

{
	"country": "cz",
       "name": "abra"								
}

Pomocí query parametru select byly vráceny pouze požadované položky.

Dotaz na vyhledání firmy podle IČ firmy bude stejný, jen s odlišností v těle, kde položku Name nahradíme za položku org_ident_number. V tomto příkladu níže zjišťujeme údaje o firmě s IČ 25097563.

{
	"country": "cz",
       "org_ident_number": "25097563"								
}

Dotaz na vrácení kolekce středisek, která jsou skrytá.

GET http://localhost:81/demodata/divisions/views/hidden

Zafiltrování skladových karet za modifikované a to po datu 2023-03-23T08:31:50.979Z.

GET http://localhost:81/demodata/storecards/views/all?select=id&changetype=updated&sincedate=2023-03-23T08:31:50.979Z

Dotaz:

POST http://localhost/data/issuedinvoices HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 404

Tělo:

{
	"docqueue_id" : "5600000101",
	"description": "Test vytvoření faktury",
	"rows": [
		{
			"rowtype": 1,
			"text" : "Test řádek č. 1",
			"division_id" : "2100000101",
			"vatrate_id" : "02100X0000",
			"totalprice": 100
		},
		{
			"rowtype": 1,
			"text" : "Test řádek č. 2",
			"division_id" : "2100000101",
			"vatrate_id" : "01500X0000",
			"totalprice": 101.5
		}
	 ]
}

Odpověď:

HTTP/1.1 201 Created
Access-Control-Allow-Origin: *
Connection: Keep-Alive
Access-Control-Allow-Methods: GET,PUT,POST,DELETE
Location: /data/issuedinvoices/1130000101
Content-Type: application/json
Access-Control-Allow-Credentials: true
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Content-Length: 6679

V hlavičce Location je uveden URI nově vytvořeného objektu.

POST http://localhost/data/import HTTP/1.1
Host: localhost 
Content-Type: application/json 
Authorization: Basic VGVzdDoxMjM=
{
    "input_document_clsid": "01CPMINJW3DL342X01C0CX3FCC",
    "output_document_clsid": "050I5SAOS3DL3ACU03KIU0CLP4",
    "input_documents": "2550000101",
    "params": {
       "docqueue_id": "P600000101"
    }
}

Dotaz:

POST http://localhost/data/import HTTP/1.1
Host: localhost 
Content-Type: application/json
Authorization: Basic VGVzdDoxMjM=
{
	"input_document_clsid": "050I5SAOS3DL3ACU03KIU0CLP4",
	"output_document_clsid": "O3BDOKTWEFD13ACM03KIU0CLP4", 
	"input_documents": "1I30000101",
	"params": { 
		"DocQueue_ID": "5600000101"
	}
}

Odpověď:

HTTP/1.1 201 Created
Content-Type: application/json
Access-Control-Allow-Origin: *
Connection: Keep-Alive
Access-Control-Allow-Credentials: true
Access-Control-Allow-Methods: GET,PUT,POST,DELETE
Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept
Content-Length: 5030

Obdoba předchozího příkladu (import DL do FV). Příklad ilustruje skutečnost, že každý importní manažer může mít vlastní specifické parametry. V tomto konkrétním příkladě (ZLV → DZV) jsou k dispozici následující:

• importtextrows (Boolean) - importuje řádky typu 0 ze zdrojového zálohového listu vydaného
• importdepositrows (Boolean) - importuje řádky typu 4 ze zdrojového zálohového listu vydaného
• vatrateidonrow (TNxOID) - ID DPH sazby, kterou se má vyplnit importovaný řádek typu 4, pokud není sazba vyplněna na zdrojovém řádku

POST http://localhost/data/import HTTP/1.1
Host: localhost
Content-Type: application/json 
Authorization: Basic QVBJOmFwaQ==
{
 "input_document_clsid": " WEN033MLM3DL35J301C0CX3F40",  
 "output_document_clsid": " S3YFE5QQNYQORJXLJWXDL3QV0K", 
 "input_documents": "1100000101",    
 "params": {
		"docqueue_id": "9700000101",  
		"depositamount": 31061,
		"importtextrows": true,
		"importdepositrows": true,
		"vatrateidonrow": "01000X0000"
	}
}

Chceme vytvořit fakturu vydanou z objednávky přijaté. V prostředí aplikaceABRA Gen bychom funkcí Vytvořit vyvolali odpovídajícího průvodce, vyplnili parametry importu a následně by se otevřela agenda Faktury vydané s připraveným dokladem, ve kterém bychom vyplnili několik zbývajících položek a fakturu uložili.

Když provádíme stejnou operaci prostřednictvím Web API, vlastnost output_document_update je ekvivalentem fáze "ve kterém bychom vyplnili několik zbývajících položek". (V rámci provádění požadavku se vytvoří objekt, na kterém můžeme ještě před uložením změnit některé vlastnosti.)

V našem konkrétním příkladě by se nám bez použití output_document_update nepodařilo fakturu vydanou uložit - pokud to zkusíme

POST http://localhost/demo15/import HTTP/1.1
Host: localhost
Content-Type: application/json
Authorization: Basic QVBJOmFwaQ==
Cache-Control: no-cache
Postman-Token: ec6e4774-7468-46cf-ac0d-26d859ce962e
{
	"input_document_clsid": "01CPMINJW3DL342X01C0CX3FCC",
	"output_document_clsid": "O3BDOKTWEFD13ACM03KIU0CLP4",
	"input_documents": "2500000101",
	"params": {
		"ImportDocuments": true,
		"UndeliveredQuantity": true,
		"DeliveryDate": "2018-06-27T15:57:00.000Z",
		"DocQueue_ID": "5600000101"
	}
}

500 Internal Server Error
{
	"title": "Chyba při importu dokladu",
	"error_code": 1520,
	"description": "Chyba při validaci objektu \"Faktura vydaná: Bez čísla\":\r\nChyba v zadání položky Řada skladových dokladů"
}

Dotaz proto rozšíříme o vlastnost output_document_update, prostřednictvím které nastavíme požadovanou Řadu skladových dokladů na P600000101 doklad Dodací list. Takto upravený dotaz již proběhne v pořádku a požadovaný objekt (faktura vydaná) se vytvoří.

POST http://localhost/demo15/import HTTP/1.1
Host: localhost
Content-Type: application/json
Authorization: Basic QVBJOmFwaQ==
Cache-Control: no-cache
Postman-Token: ec6e4774-7468-46cf-ac0d-26d859ce962e
{
	"input_document_clsid": "01CPMINJW3DL342X01C0CX3FCC",
	"output_document_clsid": "O3BDOKTWEFD13ACM03KIU0CLP4",
	"input_documents": "2500000101",
	"params": {
		"ImportDocuments": true,
		"UndeliveredQuantity": true,
		"DeliveryDate": "2018-06-27T15:57:00.000Z",
		"DocQueue_ID": "5600000101"
	},
	"output_document_update": {
		"StoreDocQueue_ID": "P600000101"
	}
}

Odpověď:

HTTP/1.1 201 Created
...

Pomocí parametru output_rows_update je možné modifikovat řádky výstupního dokumentu, v tomto případě řádky 155 a 355, vzniklé ze vstupního dokumentu. Do objektu, který je uvedený ID klíčem vstupního řádku, se zavedou modifikované řádky s obsahem, který je pod nimi popsán.

POST http://localhost/demo15/import HTTP/1.1
Host: localhost
Content-Type: application/json
Authorization: Basic QVBJOmFwaQ==
Cache-Control: no-cache
Postman-Token: ec6e4774-7468-46cf-ac0d-26d859ce962e
{
	"input_document_clsid": "01CPMINJW3DL342X01C0CX3FCC",
	"output_document_clsid": "O3BDOKTWEFD13ACM03KIU0CLP4",
	"input_documents": "2500000101",
	"params": {
		"docqueue_id": "O600000101",
		"SelectedRows": [
			"1550000101",
			"3550000101"
		]
	},
	"output_rows_update": {
		"1550000011": {
			"unitquantity": 2,
			"busorder_id": "9200000101",
			"qunit": "m",
			"docrowbatches": [
				{
					"storebatch_id": "IM10000101",
					"unitquantity": 2,
					"qunit": "m"
				}
			]
		},
		"3550000101": {
			"busorder_id": "9200000101",
			"unitquantity": 12,
			"unitprice": 1000000
		}
	}
}

Pokud používáme parametr typu List sekci params máme možnost dvojího zápisu.

Pokud se jedná o prostý List hodnot, potom je v API použití jako pole hodnot, např. "stores": [ "1500000101", "2500000101" ].

Pokud se jedná o List parametrů kde je důležitá klíčová hodnota, potom je takovýto list v JSON interpretován jako pole objektů např. "joquantities": [ {"10000101": 1 }, { "20000101": 2 } ]

V našem konkrétním příkladě si ukážeme použití obou typů parametrů.

"input_document_clsid": "HTI3OTLGNRPO32EEISEPC0XZ0K",
"output_document_clsid": "2MV0SHPYLFJOL3D4WN02HCPX5S",
"input_documents": "1360000101",
"params": {
	"docqueue_id": "1J00000101",
	"period_id": "2Q70000101",
	"stores": [
		"1500000101",
		"2500000101"
	],
	"joquantities": [
		{
		 "10000101": 1
		},
		{
		 "20000101": 2
		}
	]
  }
}

Následující příklad vytvoří daňový zálohový list přijatý z řádku bankovního výpisu.

POST http://localhost/data/import HTTP/1.1
Host: localhost
Content-Type: application/json
Authorization: Basic QVBJOmFwaQ==
Cache-Control: no-cache
Postman-Token: 81fc77e4-fb51-41e1-9f70-04f05b788e3f
{
	"input_document_clsid": "OBSCO4S1BRD13FY1010DELDFKK",
	"output_document_clsid": "ZJYWUH5I34J4VAAIHOB0ZA1FIO",
	"input_documents": "1700000101",
	"params": {
		"DocQueue_ID": "B700000101"
	}
}

1700000101 = ID řádku bankovního výpisu

B700000101 = ID řady daňových zálohových listů přijatých (DZP)

OBSCO4S1BRD13FY1010DELDFKK = packed GUID objektu řádek bankovního výpisu (BankStatementRow)

ZJYWUH5I34J4VAAIHOB0ZA1FIO = packed GUID objektu daňový zálohový list přijatý (VATReceivedDepositInvoice)

Pokud voláte importní manažer, který provádí polohování dokladů, v těle požadavku je zapotřebí specifikovat polohovací strategii a nastavit parametr AutoPrefillPosition na hodnotu true. V opačném případě by se výsledný polohovací doklad (Naskladnění do pozic nebo Vyskladnění z pozic) sice vytvořil, ale neobsahoval by žádné řádky.

Napolohování dokladu třídy Převodka - výdej (Vyskladnění z pozic) se provede následovně:

POST http://localhost/data/import HTTP/1.1
Host: localhost
Content-Type: application/json
Authorization: Basic QVBJOmFwaQ==
Cache-Control: no-cache
Postman-Token: 81fc77e4-fb51-41e1-9f70-04f05b788e3f
{
	"input_document_clsid": "0P0I5SAOS3DL3ACU03KIU0CLP4",
	"output_document_clsid": "LNQ1VOVM1TE4XJDLGNXAK0I1FS",
	"input_documents": "BR00000101",
	"params": {
		"AutoPrefillPosition": true,
		"Strategy_ID": "{37A351FA-D60D-4A98-9A58-1FD1ACAD5339}",
		"StoreGateway_ID": "1000000101",
		"DocQueue_ID": "B700000101"
	}
}

0P0I5SAOS3DL3ACU03KIU0CLP4 = packed GUID objektu Převodka - výdej (OutgoingTransfer)

LNQ1VOVM1TE4XJDLGNXAK0I1FS = packed GUID objektu Vyskladnění z pozic (LogStoreOutput)

BR00000101 = ID převodky výdej, kterou polohujeme

AutoPrefillPosition = určuje, že se mají pozice vyplňovat automaticky.

37A351FA-D60D-4A98-9A58-1FD1ACAD5339 = GUID zvolené strategie. Identifikátory jsou pevně dané výrobcem aplikace, k dispozici jsou níže uvedené možnosti.

Pro naskladnění:

• Dostupnost pozic: {4F47491B-EAFC-4B9E-A905-45B7471C6723}
• Pozice s jedním zbožím: {BD31E23F-18B7-43B9-93B6-B652714090F1}

Pro vyskladnění:

• Nejstarší zásoby: {37A351FA-D60D-4A98-9A58-1FD1ACAD5339}
• Uvolnění pozic: {CBF7FC08-CAB3-4172-9A01-A7456BD4BC35}
• Z minima pozic: {C8F75D91-DDC3-40B4-A89E-24CDCBBDD523}
• Z minima dostupných pozic: {96BA5D26-14C5-4704-AF1A-157438752679}
• Dostupnost pozic: {0881618E-DF24-4A2E-87BC-DD75BD1E3F51}
• Uvolnění nepreferovaných pozic: {CFF06E40-E587-4DFF-9680-880751B3F359}

1000000101 = ID vyskladňovacího místa

B700000101 = řada dokladů, ve které vytváříme polohovací doklad (Vyskladnění z pozic)

Nechť jsme si nadefinovali definovatelný číselník. Viz např. Vzorový postup přidání uživatelského číselníku. Nechť tento číselník má v položce Název kolekce ve WebAPI v DefRollEditoru hodnotu transportationcars. Dotaz na vrácení (GET) kolekce záznamů z tohoto číselníku:

GET http://localhost/data/transportationcars HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Dotaz na hodnotu ID uživatele:

POST http://localhost/data/qrexpr HTTP/1.1
Host: localhost
Authorization: Basic VGVzdDoxMjM=
Content-Length: 0

Vlastní výraz zapsaný v JSON formátu:

{
  "expr": "NxGetUserID"
}

Příklad výsledku: Status 200 OK

{
 "result": "SUPER00000"
}

Dotaz na název skladové karty se zadaným ID:

URL shodně jako v Příkladu 1.

Vlastní výraz zapsaný v JSON formátu:

{
  "expr": "NxGetValueFromRoll('StoreCards','Name','2100000101')"
}

Příklad výsledku: Status 200 OK

{
 "result": "Panasonic 65\" Class 4K Ultra HD TV"
}

Dotaz, zda určitý datum spadá na svátek:

URL shodně jako v Příkladu 1.

Vlastní výraz zapsaný v JSON formátu:

{
  "expr": "NxDayIsHoliday(NxStrToDate('1.1.2016'))"
}

Příklad výsledku: Status 200 OK

{
 "result": true
}

Použití NxSQL Select:

URL shodně jako v Příkladu 1.

Vlastní výraz zapsaný v JSON formátu:

{
  "expr": "NxSQLSelect('SELECT ID FROM FIRMS', '', ',', '\"')"
}

Příklad výsledku: Status 200 OK

{
 "result": "\"3200000101\",\"1100000101\",\"2000000101\",…"
}

GET - parametry key a global, parametr key může kdekoliv obsahovat *. Výsledek je vždy v poli i když jde o jeden záznam. Pokud se nic nedohledá, vrátí se status 200 a v body prázdné pole.

Všechny metody obsahují parametr global typu boolean(může být buď 1 nebo 0, anebo bez hodnoty, pak je považován za 1). Pomocí parametru se přepne, zda se data uloží na aktuálně přihlášeného uživatele anebo globálně a budou přístupné všem uživatelům.

GET http://localhost/demo/keyvalues?key=*&global=0

Příklad výsledku: Status 200 OK

[
	{
		"key": "intvalue/secondlevel",
		"value": "3"
	},
	{
		"key": "stringvalue/firstlevel",
		"value": "text"
	},
	{
		"key": "thirdlevel",
		"value": "haleluja"
	}
]

PUT/POST - parametr global, obě metody dělají to samé - aktualizují nebo založí klíč.

PUT/POST http://localhost/demo/keyvalues

Tělo je jako pole objektů klíč / hodnota. V případě jen jedné položky tento objekt nemusí být v poli.

[
	{
		"key": "intvalue/secondlevel",
		"value": "3"
	},
	{
		"key": "stringvalue/firstlevel",
		"value": "text"
	},
	{
		"key": "thirdlevel",
		"value": "haleluja"
	}
]

DELETE - parametry key a global,

DELETE http://localhost/demo/keyvalues?key=stringvalue2

Přidáním parametru executor=outprocess do požadavku se vykoná v externím exe.

GET http://localhost:80/demo/countries?executor=outprocess&select=ID&where=ID+eq+''00000CZ000''