StandardBooksi andmete lugemine ja kirjutamine Rest APIga - Redigeerimiste ajalugu

Kaupo: /* Parameetrid */

2024-04-24T11:41:20Z

Parameetrid

@@ 223. rida: / 223. rida: @@
 ''<nowiki>http://username:@hostname/api/1/IVVc</nowiki>? fields=SerNr''
-'''filter''' - Andmeid saab filtreerida selle parameetri abil. Filter on oluliselt aeglasem kui vahemik, kuna ei kasuta indekseid ja otsib läbi kõik kaardid. Kui kasutad vahemiku parameetrit, siis filter köib läbi ainult need kaardid, mis jäävad vahemikku. Sellepärast on soovitav kasutada võimalikult täpset vahemiku määrangut ja teisi filtreid.
+'''filter''' - Andmeid saab filtreerida selle parameetri abil. Filter on oluliselt aeglasem kui vahemik, kuna ei kasuta indekseid ja otsib läbi kõik kaardid. Kui kasutad vahemiku parameetrit, siis filter köib läbi ainult need kaardid, mis jäävad vahemikku. Sellepärast on soovitav kasutada võimalikult täpset vahemiku määrangut ja teisi filtreid. NB: Filter väli peab kattuma täielikult otsitava väljaga. Ei saa otsida sisu osa
 ''Näide'':
@@ 240. rida: / 240. rida: @@
 ''<nowiki>http://username:@hostname/api/1/IVVc?filter.CustCode=10100:10200&Sum4=100:1000</nowiki>''
 '''offset''' '''and''' '''limit''' - Kui päringu tulemus on suurem, kui api kasutaja suudab töödelda ühe päringuga, siis saab tulemusi jagada väiksemateks osadeks. "offset" jätab vahele määratud arvu kaarte/dokumente päringu tulemuses. "limit" piirab kaartide koguarvu päringu tulemuses.

Kaupo: /* Kaartide seoste päring */

2024-04-24T11:30:04Z

Kaartide seoste päring

←Vanem redaktsioon		Redaktsioon: 24. aprill 2024, kell 11:30
672. rida:		672. rida:
	</IVVc>		</IVVc>
	</data>		</data>
	</syntaxhighlight>Sealt saame manuse päringuks vajaliku ~~urli~~.		</syntaxhighlight>Sealt saame manuse päringuks vajaliku Attach2Vc registri kirje numbri (SerNr).

	=== Manuste pärimine ===		=== Manuste pärimine ===

Kaupo: /* Manuste pärimine Standard Booksist */

2024-04-24T11:27:58Z

Manuste pärimine Standard Booksist

←Vanem redaktsioon		Redaktsioon: 24. aprill 2024, kell 11:27
650. rida:		650. rida:
	Päring koosneb kahest osast:		Päring koosneb kahest osast:

	# Kaaride seoste päring (saame kätte ~~manuse lingi~~)		# Kaaride seoste päring (saame kätte meid huvitava dokumendi manuste lingid)
	# Manuse enda päring.		# Manuse enda päring.

	=== Kaartide seoste päring ===		=== Kaartide seoste päring ===
	Kõikides Standard Booksi registrites saab päringule lisada parameetri ''get_links=1''.		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:<blockquote><nowiki>https://mars.excellent.ee:445/api/1/IVVc?get_links=1&filter.SerNr=230008</nowiki></blockquote>Ja tulemuses on iga registrikaardi lõpus <links> osa:<syntaxhighlight lang="xml">		Näide ühe arve manuste kohta:<blockquote><nowiki>https://mars.excellent.ee:445/api/1/IVVc?get_links=1&filter.SerNr=230008</nowiki></blockquote>Ja tulemuses on iga registrikaardi lõpus <links> osa:<syntaxhighlight lang="xml">

Kaupo: /* Kaartide seoste päring */

2024-04-24T11:26:23Z

Kaartide seoste päring

←Vanem redaktsioon		Redaktsioon: 24. aprill 2024, kell 11:26
656. rida:		656. rida:
	Kõikides Standard Booksi registrites saab päringule lisada parameetri ''get_links=1''.		Kõikides Standard Booksi registrites saab päringule lisada parameetri ''get_links=1''.

	Näide ühe arve manuste kohta:<blockquote><nowiki>https://~~127~~.0.~~0.1~~:~~443~~/api/1/IVVc?get_links=1&filter.SerNr=230008</nowiki></blockquote>Ja tulemuses on iga registrikaardi lõpus <links> osa:<syntaxhighlight lang="xml">		Näide ühe arve manuste kohta:<blockquote><nowiki>https://mars.excellent.ee:445/api/1/IVVc?get_links=1&filter.SerNr=230008</nowiki></blockquote>Ja tulemuses on iga registrikaardi lõpus <links> osa:<syntaxhighlight lang="xml">
	.....		.....
	</row>		</row>
673. rida:		673. rida:

	=== Manuste pärimine ===		=== Manuste pärimine ===
	Manuste pärimiseks teme päringu Attach2Vc registri pihta. Eelpool toodud näidet kasutades saame PDFi pärida nii:<blockquote><nowiki>https://~~127~~.0.~~0.1~~:~~443~~/api/1/Attach2Vc?filter.SerNr=126&get_attachdata=true</nowiki></blockquote>Vastuses on metadata ja manuse sisu base64 kodeeringus:<syntaxhighlight lang="xml">		Manuste pärimiseks teme päringu Attach2Vc registri pihta. Eelpool toodud näidet kasutades saame PDFi pärida nii:<blockquote><nowiki>https://mars.excellent.ee:445/api/1/Attach2Vc?filter.SerNr=126&get_attachdata=true</nowiki></blockquote>Vastuses on metadata ja manuse sisu base64 kodeeringus:<syntaxhighlight lang="xml">
	<?xml version='1.0' encoding='UTF-8' standalone='yes'?>		<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
	<data register='Attach2Vc' sequence='94784' systemversion='8.5.55.3480'>		<data register='Attach2Vc' sequence='94784' systemversion='8.5.55.3480'>

Kaupo: /* Manuste pärimine */

2024-04-24T11:25:39Z

Manuste pärimine

←Vanem redaktsioon		Redaktsioon: 24. aprill 2024, kell 11:25
656. rida:		656. rida:
	Kõikides Standard Booksi registrites saab päringule lisada parameetri ''get_links=1''.		Kõikides Standard Booksi registrites saab päringule lisada parameetri ''get_links=1''.

	Näide ühe arve manuste kohta:<blockquote>/api/1/IVVc?get_links=1&filter.SerNr=230008</blockquote>Ja tulemuses on iga registrikaardi lõpus <links> osa:<syntaxhighlight lang="xml">		Näide ühe arve manuste kohta:<blockquote><nowiki>https://127.0.0.1:443/api/1/IVVc?get_links=1&filter.SerNr=230008</nowiki></blockquote>Ja tulemuses on iga registrikaardi lõpus <links> osa:<syntaxhighlight lang="xml">
	.....		.....
	</row>		</row>
670. rida:		670. rida:
	</IVVc>		</IVVc>
	</data>		</data>
	</syntaxhighlight>Sealt saame manuse ~~päringu lingi~~.		</syntaxhighlight>Sealt saame manuse päringuks vajaliku urli.

	=== Manuste pärimine ===		=== Manuste pärimine ===
	Manuste pärimiseks teme päringu Attach2Vc registri pihta. Eelpool toodud näidet kasutades saame PDFi pärida nii:<blockquote>/api/1/Attach2Vc?filter.SerNr=126&get_attachdata=true</blockquote>Vastuses on metadata ja manuse sisu base64 kodeeringus:<syntaxhighlight lang="xml">		Manuste pärimiseks teme päringu Attach2Vc registri pihta. Eelpool toodud näidet kasutades saame PDFi pärida nii:<blockquote><nowiki>https://127.0.0.1:443/api/1/Attach2Vc?filter.SerNr=126&get_attachdata=true</nowiki></blockquote>Vastuses on metadata ja manuse sisu base64 kodeeringus:<syntaxhighlight lang="xml">
	<?xml version='1.0' encoding='UTF-8' standalone='yes'?>		<?xml version='1.0' encoding='UTF-8' standalone='yes'?>
	<data register='Attach2Vc' sequence='94784' systemversion='8.5.55.3480'>		<data register='Attach2Vc' sequence='94784' systemversion='8.5.55.3480'>
688. rida:		688. rida:
	<Storage>SerNr</Storage>		<Storage>SerNr</Storage>
	<ContentId></ContentId>		<ContentId></ContentId>
	<attachment>JVBERi0xLjcKJbe+raoKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZwovUGFnZXMgMiAwIFIKL091dHB1dEludGVudHMgWyAzOSAwIFIgXQovTWV0YWRhdGEgNDAgMCBSCi9NYXJrSW5mbyA0MiAwIFIKPj4KZW5kb2JqCjIgMCBvYmoKPDwKL1R5cGUgL1BhZ2VzCi9LaWRzIFsgNCAwIFIgXQovQ291bnQgMQo==		<attachment>JVBERi0xLjcKJbe+raoKMSAwIG9iago8PAovVHlwZSAvQ2F0YWxvZOSAwIFIgXQovTWV0YWRhdGEgNDAgMCBSCi9NYXJrSWBhZ2VzCi9LaWRzIFsgNCAwIFIgXQovQ291bnQgMQo==</attachment>
	</attachment>
	</Attach2Vc>		</Attach2Vc>
	</data>		</data>

Kaupo: /* Manuste pärimine Standard Booksist */

2024-04-24T11:22:41Z

Manuste pärimine Standard Booksist

@@ 653. rida: / 653. rida: @@
 # Manuse enda päring.
-johhaidii<br />
+=== Kaartide seoste päring ===
 ==Head tavad Standard Booksi Rest API kasutamiseks==

Kaupo – 24. aprill 2024, kell 10:19

2024-04-24T10:19:59Z

←Vanem redaktsioon		Redaktsioon: 24. aprill 2024, kell 10:19
640. rida:		640. rida:
	(Sel juhul tuleks kontakti nimeks vaid "Saue ")		(Sel juhul tuleks kontakti nimeks vaid "Saue ")

	~~Peame kodeerima~~ kõik postitatavad andmed kohe URL formaati:		Kodeerime '''kõik''' postitatavad andmed kohe URL formaati (kuigi tegelikult tühikuid tühikutena on okei saata):
	set_field.Name=Saue%20%26%20Saku%20OÜ&		set_field.Name=Saue%20%26%20Saku%20OÜ&
	<br />
			== Manuste pärimine Standard Booksist ==
			Alates 2024 aasta kevade versiooniuuendusest saab Standard Booksist pärida kaartidele lisatud manuseid.

			Lihtsaim kasutusjuhtum on see, kui näitek veebipood POSTib arve Standard Booksi, see kinnitatakse, tekib arvele manusesse arve PDF, mis genereeritakse vastavalt Standard Booksi dokumendimallile. Seejärel saab Veebipood enda keskkonda pärida täpselt selle arve PDFi, mille Standard Books on genereerinud. Teine levinud kasutusjuhtum on artiklite piltide, sertifikaatide ja kasutusjuhendite pärimine veebikeskkonda.

			Päring koosneb kahest osast:

			# Kaaride seoste päring (saame kätte manuse lingi)
			# Manuse enda päring.

			johhaidii<br />

	==Head tavad Standard Booksi Rest API kasutamiseks==		==Head tavad Standard Booksi Rest API kasutamiseks==

Kaupo: /* Koostame kliendi */

2024-03-15T08:02:17Z

Koostame kliendi

←Vanem redaktsioon		Redaktsioon: 15. märts 2024, kell 08:02
332. rida:		332. rida:
	<CustCode>111</CustCode>		<CustCode>111</CustCode>
	<PayDate>2022-04-29</PayDate>		<PayDate>2022-04-29</PayDate>
	<Addr0>~~Linna Kohvik OÜ~~</Addr0>		<Addr0>Ehitajate tee 91/2-24</Addr0>
	<Addr1>~~Kivi tee 12~~</Addr1>		<Addr1>Mustamäe linnaosa</Addr1>
			<Addr2>Tallinn</Addr2>
			<Addr3>Harju maakond</Addr3>
			<Addr4>12915</Addr4>
	<PayDeal>7</PayDeal>		<PayDeal>7</PayDeal>
	<pdays>7</pdays>		<pdays>7</pdays>
540. rida:		543. rida:
	<PayDate>2019-02-17</PayDate>		<PayDate>2019-02-17</PayDate>
	<Addr0>Karjaküla OÜ</Addr0>		<Addr0>Karjaküla OÜ</Addr0>
	<Addr1>~~Saue~~</Addr1>		<Addr1>Ehitajate tee 91/2-24</Addr1>
	<Addr2>~~Kodu 13/3~~</Addr2>		<Addr2>Tallinn</Addr2>
	<Addr3>~~Maja, 99212~~</Addr3>		<Addr3>Harju maakond</Addr3>
			<Addr4>12915</Addr4>
	<ClientContact>Mariliis Männik</ClientContact>		<ClientContact>Mariliis Männik</ClientContact>
	<PayDeal>7</PayDeal>		<PayDeal>7</PayDeal>

Kaupo: /* Koostame kliendi */

2024-03-15T07:58:41Z

Koostame kliendi

←Vanem redaktsioon		Redaktsioon: 15. märts 2024, kell 07:58
418. rida:		418. rida:
	--header 'Cookie: HSESSION=F781FB1F-605F90E0-EC009210-F7841492-3AE28E44; country=global' \		--header 'Cookie: HSESSION=F781FB1F-605F90E0-EC009210-F7841492-3AE28E44; country=global' \
	--data-raw 'set_field.Name=Karjaküla OÜ&		--data-raw 'set_field.Name=Karjaküla OÜ&
	set_field.InvAddr0=~~Saue~~&		set_field.InvAddr0=Ehitajate tee 91/2-24&
	set_field.InvAddr1=~~Kodu 13/3~~&		set_field.InvAddr1=Mustamäe linnaosa&
	set_field.InvAddr2=~~Maja, 99212~~&		set_field.InvAddr2=Tallinn&
			set_field.InvAddr3=Harju maakond&
			set_field.InvAddr4=12915&
	set_field.Phone=55887744&		set_field.Phone=55887744&
	set_field.CountryCode=EE&		set_field.CountryCode=EE&
444. rida:		446. rida:
	<Name>Karjaküla OÜ</Name>		<Name>Karjaküla OÜ</Name>
	<Person>Mariliis Männik</Person>		<Person>Mariliis Männik</Person>
	<InvAddr0>~~Saue~~</InvAddr0>		<InvAddr0>Ehitajate tee 91/2-24</InvAddr0>
	<InvAddr1>~~Kodu 13/3~~</InvAddr1>		<InvAddr1>Mustamäe linnaosa</InvAddr1>
	<InvAddr2>~~Maja, 99212~~</InvAddr2>		<InvAddr2>Tallinn</InvAddr2>
			<InvAddr3>Harju maakond</InvAddr3>
			<InvAddr4>12915</InvAddr4>
	<Phone>55887744</Phone>		<Phone>55887744</Phone>
	<CustCat>EES</CustCat>		<CustCat>EES</CustCat>

Kaupo: /* Seadistamine */

2024-01-04T12:38:01Z

Seadistamine

←Vanem redaktsioon		Redaktsioon: 4. jaanuar 2024, kell 12:38
1. rida:		1. rida:
	==Seadistamine==		==Seadistamine==
	Alates versioonist 8.0 saab HansaWorldi toodetes kasutada Web API päringuid andmete ~~väljastamiseks~~.		Alates versioonist 8.0 saab HansaWorldi toodetes kasutada Web API päringuid andmete pärimiseks ja kirjutamiseks.

	===Eeltingimused===		===Eeltingimused===
36. rida:		36. rida:
	Näide, kus API seadistatud SSLiga:		Näide, kus API seadistatud SSLiga:

	Väli '''Lubatud IP-d''' tuleb täita, kui on soov lubada ainult konkreetsetel süsteemidel teha Rest-API päringuid. Kui väljale on vaja lisada mitu aadressi, siis tuleb need eraldada komaga. Näide:		Väli '''Lubatud IP-d''' tuleb täita, kui on soov lubada ainult konkreetsetel süsteemidel teha Rest-API päringuid. Kui väljale on vaja lisada mitu aadressi, siis tuleb need eraldada komaga. Näide: ''90.191.43.252,213.35.184.82''[[Fail:Uus ligipääs funktsioonidele veebist.png\|tühi\|pisi\|812x812px]]

	''90.191.43.252,213.35.184.82''
	[[Fail:Uus ligipääs funktsioonidele veebist.png\|tühi\|pisi\|812x812px]]

	===Kasutajagrupid===		===Kasutajagrupid===
68. rida:		65. rida:

	==Kasutamine==		==Kasutamine==
	~~· Lugeda saab kõiki hansa registreid ja andme-blokke, sealhulgas HALiga tehtud registreid, seadistusi, muudatusi olemasolevatel kaartidel.~~

	~~· Päringuga~~ on kasutatav otsimine ja filtreerimine (käitub nagu aruanne)		* Lugeda saab kõiki hansa registreid ja andme-blokke, sealhulgas HALiga tehtud registreid, seadistusi, muudatusi olemasolevatel kaartidel.
			* Päringuga on kasutatav otsimine ja filtreerimine (käitub nagu aruanne)
			* Jätame meelde eelmise päringu ja saame väljastada vahepeal muutunud andmeid
			* Kasutajanimi, parool töötavad. Samuti kontrollitakse andmete lugemise õigust kasutajagruppidest
			* Saab määrata väljade nimekirja kaardil, mida väljastada. Näide: varem oli üks üherealine müügiarve ca 350 XML rida pikk, siis nüüd saan lasta endale saata vaid näiteks 5 rida per arve.

	~~· Jätame meelde eelmise päringu ja saame väljastada vahepeal muutunud andmeid~~		==== URL’I kasutamine ====

	~~· Kasutajanimi, parool töötavad. Samuti kontrollitakse andmete lugemise õigust kasutajagruppidest~~

	· Saab määrata väljade nimekirja kaardil, mida väljastada. Näide: varem oli üks üherealine müügiarve ca 350 XML rida pikk, siis nüüd saan lasta endale saata vaid näiteks 5 rida per arve.

	===URL’I kasutamine===
	Andmed päritakse URLiga ehk inimkeeli - klient ütleb Hansa serverile aadressi, mille põhjal Hansa server väljastab vastava info.		Andmed päritakse URLiga ehk inimkeeli - klient ütleb Hansa serverile aadressi, mille põhjal Hansa server väljastab vastava info.
	{\| class="wikitable"		{\| class="wikitable"
114. rida:		108. rida:
	\|}		\|}

	~~'''~~Eraldajad:~~'''~~		==== Eraldajad: ====

	*? - Sisestatakse peale Registri defineerimist, et kirjeldada filtreid.		*? - Sisestatakse peale Registri defineerimist, et kirjeldada filtreid.
	*& - Sisestatakse erineva tüübiga filtreeringute vahele.		*& - Sisestatakse erineva tüübiga filtreeringute vahele.

	~~'''~~Näidis URL:~~'''~~		==== Näidis URL: ====
	<nowiki>https://mars.excellent.ee:4455/api/1/ivvc?filter.CustCode=105&fields=SerNr,OKFlag,Addr0,ArtCode,CustCode,InvDate,TransDate,Objects</nowiki>		<nowiki>https://mars.excellent.ee:4455/api/1/ivvc?filter.CustCode=105&fields=SerNr,OKFlag,Addr0,ArtCode,CustCode,InvDate,TransDate,Objects</nowiki>
	Vastus: <syntaxhighlight lang="xml">		Vastus: <syntaxhighlight lang="xml">