Uuendatud 26. august 2026
Kas API-ga saab pärida kaartide külge lisatud manuseid?
Excellent Booksis saab erinevates registrites olevatele kaartidele lisada faile, näiteks arve PDF-e, artiklite pilte või sertifikaate. Need failid paiknevad kaardi küljes „Kirjaklambri“ ikooni all. API võimaldab neid faile andmebaasist kätte saada ning edasi kasutada, näiteks veebipoes või teises tarkvaralahenduses.
Näidiskasutus 1:
Veebipood sisestab API POST päringuga uue müügiarve Excellent Booksi andmebaasi. Kui see arve Excellent Booksis kasutaja poolt kinnitatakse, tekib arve manusesse automaatselt “Kirjaklambri” ikooni alla PDF arve fail. See fail genereeritakse vastavalt Excellent Booksis kirjeldatud arve dokumendimallile. Seejärel saab veebipood API-ga pärida ehk tõmmata enda keskkonda selle sama arve PDF faili.
Näidiskasutus 2:
Excellent Booksis on Artiklite kaartidele võimalik lisada toote pildid, sertifikaatide dokumendid või kasutusjuhendid. Need faili asuvad Artikli kaardi küljes “Kirjaklambri” ikooni all. Selliseid lisatud faile saab Excellent Booksist saata API-ga mõnda välisesse veebikeskkonda, kus neid kuvatakse tootelehel või haldustarkvaras.
Manuste pärimine toimub kahes etapis:
- Kaardiga seotud manuste linkide pärimine;
- Konkreetse manuse (faili) sisu pärimine.
1. Kaartide seoste päring
Kõikides Excellent Booksi registrites saab päringule lisada parameetri:
See parameeter lisab vastusesse <links> sektsiooni, mis sisaldab infot kaardi külge seotud elementide kohta. Nende vahel on “Attach2Vc” registrile viitavad lingid ehk tegu on manustega (failidega), või muud lingid (MailVc, ORVc, QTVc jne) ehk siis on tegu registritevaheliste seostega Booksi sees, mitte failidega.
Näide: müügiarve manuste pärimine ehk päring ühe konkreetse arve (SerNr=230008) linkide saamiseks:
https://tes.excellent.ee:123/api/1/IVVc?get_links=1&filter.SerNr=230008
Vastuse lõpus kuvatakse <links> osa:
......</row>
</rows>
<links>
<link comment='Arve 230008.pdf 406 KB'>
<url>/api/1/Attach2Vc/126</url>
</link>
<link comment='Arve 230008'>
<url>/api/1/MailVc/86</url>
</link>
</links>
</IVVc>
</data>Oluline on tuvastada, milline link viitab Attach2Vc registrile — see kirjeldab manust. Siin näites on manuse SerNr 126, mida kasutatakse järgmises etapis faili kaasatoomiseks.
2. Manuste (faili) sisu pärimine
Kui eelneva lingi päringu kaudu on selgunud manuse SerNr, tehakse järgmine päring “Attach2Vc” registri pihta.
Saame PDF faili pärida nii:
https://tes.excellent.ee:123/api/1/Attach2Vc?filter.SerNr=126&get_attachdata=true
Päringuga tagastatakse metaandmed (faili nimi, suurus, tüüp jne) ning <attachment> element, mis sisaldab faili base64 kodeeringut.
Faili sisu tagastatakse base64 kodeeringus. Base64 sisu tuleb sinu süsteemis dekodeerida, et saada tegelik fail (PDF, pilt, tekstifail vms).
Näide päringu vastusest:
<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
<data register='Attach2Vc' sequence='94784' systemversion='8.5.55.3480'>
<Attach2Vc register='Attach2Vc' sequence='94778' url='/api/1/Attach2Vc/126'>
<UUID>9B158C54-CE868FEC-17890241-4A8BB8B4-07A73BC0</UUID>
<ServerSequence>-1</ServerSequence>
<SyncFlags></SyncFlags>
<SerNr>126</SerNr>
<FileName>Arve 230008.pdf</FileName>
<PackTyp>0</PackTyp>
<Uploading>0</Uploading>
<FileSize>134</FileSize>
<Type>0</Type>
<Storage>SerNr</Storage>
<ContentId></ContentId><attachment>JVBERi0xLjcKJbe+raoKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZOSAwIFIgXQovTWV0YWRhdGEgNDAgMCBSCi9NYXJrSWBhZ2VzCi9LaWRzIFsgNCAwIFIgXQovQ291bnQgMQo==</attachment>
</Attach2Vc>
</data>