API: Skirtumas tarp puslapio versijų

Iš Lobasoft ERP apskaitos sistema.
Jump to navigation Jump to search
12 eilutė: 12 eilutė:
 
== Dažniausiai naudojamos užklausos==
 
== Dažniausiai naudojamos užklausos==
 
* Prekių sąrašas <code>base_url/Items?$select=Key,Name,Barcode,UpdatedAt</code>.
 
* Prekių sąrašas <code>base_url/Items?$select=Key,Name,Barcode,UpdatedAt</code>.
 +
* Prekių sąrašas su nuotraukomis <code>base_url/Items?$select=Key,Name,Barcode,UpdatedAt&$expand=ItemFiles($select=FileName,ContentType)</code>.
 
* Einamieji atsargų likučiai <code>base_url/InventoryBalances</code>.
 
* Einamieji atsargų likučiai <code>base_url/InventoryBalances</code>.
* Einamieji atsargų likučiai <code>base_url/SalesPrices?$expand=Item($select=Key,Name,Barcode),SalesPriceList($select=Name)&$select=UnitPrice,UpdatedAt</code>.
+
* Pardavimo kainos <code>base_url/SalesPrices?$expand=Item($select=Key,Name,Barcode),SalesPriceList($select=Name)&$select=UnitPrice,UpdatedAt</code>.

18:00, 2 rugsėjo 2021 versija

Prieiga per API

Sistemos REST API įgyvendintas pagal OData standartą (žr. https://www.odata.org/getting-started/basic-tutorial/). OData metadatuomenys preinami adresu base_url/$metadata, kur base_url - bazinis bazės adresas.

  • Autentifikavimas atliekamas basic authentication būdu.
  • Užklausose turėtų būti naudojamas puslapiavimas - imama ne daugiau nei po 500 įrašų. Įrašų kiekis gali būti apribotas. Pvz.: prekių sąrašo trečio puslapio įrašų paėmimui siunčiama užklausa: base_url/Items?$skip=1000&$top=500 (t.y. praleidžiama 2 puslapiai po 500 įrašų ir imami 500 įrašų iš trečio puslapio).
  • Užklausose turi būti nurodomi reikalingi laukai naudojant $select operatorių. Pvz.: jeigu iš prekių sąrašo reikalingas tik prekės kodas ir pavadinimas, siunčiama tokia užklausa: base_url/Items?$skip=1000&$top=500&$select=Key,Name,UpdatedAt.
  • Susijusių įrašų paėmimui naudojamas $expand opreatorius. Pvz.: norint kartu su prekės duomenimis gauti informaciją apie prekės grupę, kuriai ta prekė priklauso, siunčiama užklausa base_url/Items?$skip=1000&$top=500&$select=Key,Name&$expand=ItemGroup($select=Name).
  • Įrašų filtravimui naudojamas $filter operatorius. Pvz.: prekių, kurios buvo koreguotos po 2021-01-01 d. paėmimui siunčiama užklausa base_url/Items?$select=Key,Name,UpdatedAt&$filter=UpdatedAt+ge+2021-01-01.
    • Visos duomenų aibės turi lauką UpdatedAt, kurio pagalba galima paimti tik tuos įrašus, kurie yra pasikeitę.

Dažniausiai naudojamos užklausos

  • Prekių sąrašas base_url/Items?$select=Key,Name,Barcode,UpdatedAt.
  • Prekių sąrašas su nuotraukomis base_url/Items?$select=Key,Name,Barcode,UpdatedAt&$expand=ItemFiles($select=FileName,ContentType).
  • Einamieji atsargų likučiai base_url/InventoryBalances.
  • Pardavimo kainos base_url/SalesPrices?$expand=Item($select=Key,Name,Barcode),SalesPriceList($select=Name)&$select=UnitPrice,UpdatedAt.