Izmantotā SERP versija ir 8.5 2019-06-05 build 85310221, testēts, izmantojot Postman.
Uzstadīšana
- Sistēma → Iestatījumi → Papildus funkcijas Atķeksēt iestatījumus: ☑ Web REST API un, ja izmanto HTTP, ☑ Atļaut HTTP autentifikāciju.
REST API lietotājam (Sistēma → Reģistri → Personas laukā Personu grupas) izveido jaunu vai piešķirt kādu esošo Personu grupu (Sistēma → Iestatījumi → Personu grupas) ar tiesībām:
Darbība Rest API Pilns 0 API pieprasījumi tiek sūtīti uz http://localhost:8085/api/1/IVVc , kur:
localhost:8085 ir links uz SERPu, ja manuāli norādām portu - izmantojam HTTP vai HTTPS;
api/ norāda, ka izmantos REST API;
1/ norāda uz kompānijas kodu no kompāniju iestatījumiem;
IVVc šajā gadījumā ir Rēķinu reģistrs, bet tur var norādīt jebkuru, arī custom vai block reģistru, ar kuru vēlas strādāt;
Postman sadaļā Authorization izvēlēties opciju Basic Auth un ievadīt tās Personas datus, kura ir Personu grupā ar Rest API tiesībām (2. punkts):
Lietošana
Laikā, kad top raksts, Hansa apgalvo, ka atbalsta GET, POST un PATCH REST API komandas.
...
Piem., http://localhost:8085/api/1/IVVc?sort=CustCode&fields=SerNr,CustCode,Addr0
Datu iegūšana
GET
Atbildes uz visiem pieprasījumiem varam formatēt, izmantojot GET papildu parametrus, kurus savā starpā var brīvi kombinēt:
...
Piem., http://localhost:8085/api/1/IVVc?updates_after=16213
...
Datu rakstīšana
Datus rakstīšanai pastāv 2 parametri:
...
| Note |
|---|
Datu rakstīšana nestrādā uz blokveida un custom reģistriem. Mēģinājums rediģēt custom reģistru crasho DB. |
POST
Ar POST metodi var izveidot jaunus ierakstus.
Piem., http://localhost:8085/api/1/IVVc?set_field.SerNr=99999&set_field.CustCode=10101&set_row_field.0.ArtCode=10&set_row_field.0.Quant=7 - klientam 10101 izveidos rēķinu Nr. 99999 ar 7 artikuliem Nr.10 pirmajā rindā.
PATCH
| Note |
|---|
PATCH pagaidām nestrādā |
...
Piem., http://localhost:8085/api/1/IVVc/99999?set_field.CustCode=20202&set_row_field.0.Quant=9 - rēķinam Nr. 99999 nomainīs klientu uz 20202 un pirmās rindas artikulu skaitu uz 9.
Sekvences numuri
Katrs REST API pieprasījums iekš <data> taga atgriež numuru sequence, kuri pieaug kaut kā. To var izmantot, atceroties katra pieprasījuma atbildes sekvenci un, kad no jauna kaut kādi dati jāiegūst, var izmantot šo skaitli inkrementālajam importam.
<data register="ORVc" sequence="16197" sort="SerNr" key="SerNr" systemversion="8.5.31.221">
JTE TODOs:
- kā POST un PATCH tiekt galā ar diakritiskajām zīmēm (NETIEK) vai arī saprast, kādu charsetu Hansa izmanto, vai arī saprast, kā pareizi pieprasījumā norādīt to
- kā PATCH tiek galā ar custom un blokveida reģistriem (NETIEK)