Uuendatud 27. veebruar 2025
Kas API-ga saab pärida kaartide külge lisatud manuseid?
Näidiskasutus 1:
Kui veebipood sisestab API POST päringuga uue müügiarve Standard Booksi andmebaasi ja see arve Standard Booksis kinnitatakse, tekib arve manusesse “Kirjaklambri” ikooni alla PDF fail. See fail genereeritakse vastavalt Standard Booksis kirjeldatud arve dokumendimallile. Seejärel saab veebipood enda keskkonda API-ga pärida sama arve PDF faili.
Näidiskasutus 2:
Standard Booksis on Artiklite kaartidele võimalik lisada toote pildid, sertifikaatide dokumendid või kasutusjuhendid. Need faili asuvad kaardi küljes “Kirjaklambri” ikooni all. Selliseid lisatud faile saab Standard Booksist saata API-ga veebikeskkonda.
API päring koosneb kahest osast:
-
Kaaride seoste päring (saad kätte sind huvitava dokumendi manuste lingid)
-
Manustatud faili enda päring.
Kaartide seoste päring
Kõikides Standard Booksi registrites saab päringule lisada parameetri:
get_links=1
Kui link viitab registrile “Attach2Vc” on tegu manustatud failiga. Kui link viitab mõnele muule registrile (MailVc, ORVc, QTVc jne) on tegu kaartide omavahelise seosega Standard Booksis sees. Näide ühe arve manuste kohta:
https://tes.excellent.ee:123/api/1/IVVc?get_links=1&filter.SerNr=230008
Ja tulemuses on iga registrikaardi lõpus <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>Sealt saame manuse päringuks vajaliku Attach2Vc registri kirje numbri (SerNr).
Manuste pärimine
Manuste pärimiseks teme päringu “Attach2Vc” registri pihta. Eelpool toodud näidet kasutades saame PDF faili pärida nii:
https://tes.excellent.ee:123/api/1/Attach2Vc?filter.SerNr=126&get_attachdata=true
Vastuses on metadata ja manuse sisu base64 kodeeringus:
<?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>