Uuendatud 25. juuni 2025
Kuidas API POST päringuid vormistada?
Selleks, et teha uusi sisestusi Standard Books’i registritesse kasutatakse POST funktsionaalsust. Andmete lisamine erineb andmete pärimisest formaadi poolest. Lisamine toimub API URL’i kasutades.
Andmete lugemisest GET päringutega loe SIIT
POST PÄRINGU ELEMENDID
URL, millega postitatakse uusi sisestusi Standard Books keskkonda sisaldab järgnevaid elemente:
Kasutaja – Standard Books kasutaja, millel on lisatud kasutajagrupiga õigus toimingule „RestAPI“
Parool – Eelnevalt kirjeldatud kasutaja parool.
IP – Standard Books serveri IP.
Port – Standard Books serveri HTTP/HTTPS port.
Funktsioon – Tähistab funktsiooni, mida kasutatakse. Rest API puhul on tegemist alati „api“-ga.
Ettevõte – Standard Books serveris paikneva ettevõtte number. Leitad Standard Booksis Ettevõtete registrist.
Register – Tähistab registrit, kuhu soovitakse uus kaart sisestada.
Välja kirjeldus – Tähistab välja täitmisfunktsiooni Set_field, välja tehnilist nimetust ja välja sisestust.
Maatriksi välja kirjeldus – Tähistab maatriksi välja täitmisfunktsiooni Set_row_field, välja tehnilist nimetust ja välja sisestust.
Eraldajad
Koolon [:] – Kasutatakse elementide Kasutaja ja Parool, IP ja Port vahel
[@] – Kasutatakse elementide Parool ja IP vahel.
Küsimärk [?] – Kasutatakse elementide Register ja Välja kirjeldus vahel
Võrdusmärk [=] – Kasutatakse elementide Välja kirjeldus ja välja sisestuse vahel
Ampersand [&] – Kasutatakse, kui soovitakse kirjeldada rohkem kui 1 välja sisestust.
Väljade kirjeldused URL’is
Selleks, et Rest API kasutamisel andmeid Standard Booksi kirjutada, tuleb kirjeldada ära väljad. URL’i lõpus on võimalik defineerida kaardi kõikide väljade informatsioon. Kaardi ja maatriksi väljade puhul näeb see välja erinev.
Kaardi väli:
Set_field.[välja tehniline nimetus]=[välja sisestus]
Maatriksi väli:
Set_row_field.[maatriksi rea number]. [välja tehniline nimetus]=[välja sisestus]
NB! Maatriksi rea numbrid algavad nullist (0) ehk 0 on esimene rida, 1 on teine rida jne.
Väljade kirjeldused saab URL’is üksteise järgi lisada kasutades eraldajat [&].
curl -X POST ‘http://SJ:@127.0.0.1:8080/api/1/CUVc?set_field.Code=301&set_field.Name=Test%20%26%20Co’
Antud päring muudab müügiarve, koodiga 10000014, maatriksi esimesel real artikli koguse 100 peale.
Manuste lisamine POST päringuga
Standard Booksis on erinevate kaartide ja dokumentide külge täiendavaid faile ehk manuseid. Kui API kaudu lisatakse uusi dokumente või kaarte ja soov on lisada ka manused külge, siis Standard Booksis on võimalik kasutada Excellent Portali lahendust. Selleks, et manuste POST-mine töötaks, on vaja:
a) Booksi API moodulit;
b) Aktiveeritud “Excellent Portal” või konsultandi pool aktiveeritud veebifunktsiooni WebExcellentAPI.hal
Manuste POST-mine toimub aadressile:
https://server:port/WebExcellentAPI.hal?action=action®ister=doupload&id=NNN®name=XXX
XML sisu:
<file><base64>VGhpcyBpcyBteSBmaWxlLiBTbWFsbCBidXQgcHJldHR5LiA=</base64><filename>myfile.pdf</filename></file>
Curl näidis ühe testserveri pihta:
curl –location ‘https://mars.excellent.ee:4455/WebExcellentAPI.hal?action=action®ister=doupload&id=24410054®name=IVVc&compno=2’ \
–header ‘Content-Type: application/x-www-form-urlencoded;charset=utf-8’ \
–header ‘Accept: application/json’ \
–header ‘Authorization: Basic aHR0cHM6Ly93d3cueW91dHViZS5jb20vd2F0Y2g/dj1kUXc0dzlXZ1hjUQ==’ \
–data ‘<file>
<base64>VGhpcyBpcyBteSBmaWxlLiBTbWFsbCBidXQgcHJldHR5LiA=</base64>
<filename>myfile.pdf</filename>
</file>’
Muuta tuleb ise:
1. Serveri aadressiks enda serveri aadress
2. Pordiks oma serveri HTTPS port
3. regname= parameetrisse registri kood
4. id= parameetrisse registrikaardi SerNr väärtus.
5. compno= parameeter on teie ettevõtte kood (kui seda parameetrit ei saada, positakse manus ettevõttesse 1.
6. XMLi väli <base64> on faili sisu base64 kodeeringus
7. XMLi väli <filename> on faili nimi
8. parameetreid action=action®ister=doupload& ärge muutke.
Saadaval on registrid:
Arved (IVVc)
Ostuarved (VIVc)
Tellimused (ORVc)
Kontaktid (CUVc)
Palga mooduli Dokumendid (EPOrderDocVc)
Palga mooduli Töötajad (EmplVc)
Palga mooduli Lepingud (ContractVc)
Palga mooduli Planeeritud puudumised (PlanAbsenceVc)
Palga mooduli Töögraafikud (EPShiftSheetVc)
OAuth audentifitseerimise kohta loe täpsemalt SIIT
Registrite ja tabelite kirjeldused:
Selleks, et leida enda vajaliku registri ja selle väljade tehnilised nimetused leiad Standard Books programmis:
moodul Tehnika > Aruanded > “Eksport/import formaat”.
Aruande seest on võimalik otsida kasutajale sobiv register ja selle sisesed väljade nimetused. Registrite ja tabelite kirjeldused leiad ka SIIT
REST API vers.2 DESCRIPTION IN ENGLISH
(SOAP, api url)
Sind võivad huvitada ka need artiklid:
API päringute turvalisus ja kasutajaõigused