API: Skirtumas tarp puslapio versijų
Jump to navigation
Jump to search
(Naujas puslapis: == Prieiga per API ==) |
|||
| 1 eilutė: | 1 eilutė: | ||
== Prieiga per API == | == Prieiga per API == | ||
| + | |||
| + | Sistemos REST API įgyvendintas pagal OData standartą (žr. https://www.odata.org/getting-started/basic-tutorial/). OData metadatuomenys preinami adresu <code>base_url/$metadata</code>, 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. Pavyzdžiui, trečio puslapio įrašų paėmimui siunčiama užklausa: <code>base_url/Items?$skip=1000&$top=500</code> (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: <code>base_url/Items?$skip=1000&$top=500&$select=Key,Name,UpdatedAt</code>. | ||
17:25, 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. Pavyzdžiui, 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.