Atnaujinta 09. July 2024
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.
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)
Tave taip pat gali dominti šie straipsniai:
API päringute turvalisus ja kasutajaõigused