KiDocExchange - Revision history

Admin at 13:03, 17 April 2024

2024-04-17T13:03:45Z

← Older revision		Revision as of 16:03, 17 April 2024
Line 31:		Line 31:
	= WSDL =		= WSDL =

	KiDocExchange veebiteenuse WSDL fail on aadressil [~~http~~://services.krediidiinfo.ee/KiDocExchange.wsdl ~~http~~://services.krediidiinfo.ee/KiDocExchange.wsdl].		KiDocExchange veebiteenuse WSDL fail on aadressil [https://services.krediidiinfo.ee/KiDocExchange.wsdl https://services.krediidiinfo.ee/KiDocExchange.wsdl].


Line 364:		Line 364:
	<pre>		<pre>
	/** DEFINE PARAMETERS */		/** DEFINE PARAMETERS */
	$wsdl = '~~http~~://services.krediidiinfo.ee/KiDocExchange.wsdl';		$wsdl = 'https://services.krediidiinfo.ee/KiDocExchange.wsdl';
	$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';		$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
	$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter		$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter

Annika: /* Näidis pseudokoodina */

2024-02-05T19:11:22Z

Näidis pseudokoodina

← Older revision		Revision as of 22:11, 5 February 2024
Line 387:		Line 387:
	);		);

	/** ~~INIT~~ FILE TRANSFER */		/** FILE TRANSFER */
	$fileId = $client->startUpload($testFileName);		$fileId = $client->startUpload($testFileName);
			$md5Actual = $client->uploadFIle($fileId, $testFileContent);
	~~/** SEND FILE CONTENT */~~		$md5Expected = md5($testFileContent); // md5 checksum to verify data integrity is optional
	$client->~~uploadChunk~~($fileId, $testFileContent); ~~// no need to seperate content into multiple chunks unless file is extremely big~~		if ($md5Expected != $md5Actual) {
			// content upload failed, md5 returned does not match expected content md5
	~~/** FINISH UPLOAD */~~		}
	$~~md5~~ = md5($testFileContent); // md5 checksum to verify data integrity
	~~$reponseCode = $client->finishUpload($fileId, $md5);~~
	if ($~~reponseCode~~ != 0) {
	// upload failed, ~~check response code for reason~~
	}

	/** DOWNLOAD FILE WITH ONE REQUEST (SUGGESTED) */		/** DOWNLOAD FILE WITH ONE REQUEST (SUGGESTED) */

Annika: /* Meetodid */

2024-02-05T19:04:08Z

Meetodid

@@ Line 70: / Line 70: @@
 | xs:integer
 | Unikaalne faili id Creditinfo serveris.
 |}

Annika: /* Näidis pseudokoodina */

2024-01-03T11:26:28Z

Näidis pseudokoodina

← Older revision		Revision as of 14:26, 3 January 2024
Line 369:		Line 369:
	$md5 = md5($testFileContent); // md5 checksum to verify data integrity		$md5 = md5($testFileContent); // md5 checksum to verify data integrity
	$reponseCode = $client->finishUpload($fileId, $md5);		$reponseCode = $client->finishUpload($fileId, $md5);
	if ($reponseCode == 0) {		if ($reponseCode != 0) {
	// upload failed, check response code for reason		// upload failed, check response code for reason
	}		}

	/** DOWNLOAD FILE */		/** DOWNLOAD FILE WITH ONE REQUEST (SUGGESTED) */
			$fileId = 12345; // actual ID is aquired via getDownloadQueue response
			$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
			$fileContent = $client->downloadFile($fileId);
			saveFile($fileName, $fileContent);

			/** DOWNLOAD FILE AS CHUNKS */
	$fileId = 12345; // actual ID is aquired via getDownloadQueue response		$fileId = 12345; // actual ID is aquired via getDownloadQueue response
	$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response		$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response

Annika: /* downloadFile */

2024-01-03T11:20:51Z

downloadFile

← Older revision		Revision as of 14:20, 3 January 2024
Line 145:		Line 145:
	\| fileContent		\| fileContent
	\| xs:base64Binary		\| xs:base64Binary
	\| Faili ~~alamosa~~		\| Faili sisu
	\|}		\|}


	=== downloadChunk ===		=== downloadChunk ===

Annika: /* Meetodid */

2024-01-03T11:09:37Z

Meetodid

@@ Line 124: / Line 124: @@
 | xs:integer
 | Kui 0, siis faili üleslaadimine õnnestus. Kui negatiivne, siis tekkis mingi viga (vt veakoodide).
 |}
@@ Line 264: / Line 286: @@
 | Faili staatust täpsustav info
 |}
 = Veakoodid =

Annika at 12:01, 5 May 2023

2023-05-05T12:01:20Z

← Older revision		Revision as of 15:01, 5 May 2023
Line 6:		Line 6:

	KiDocExchange on Creditinfo veebiteenus failide saatmiseks ja vastuvõtmiseks.		KiDocExchange on Creditinfo veebiteenus failide saatmiseks ja vastuvõtmiseks.


	= Failide edastamine ja vastuvõtmine=		= Failide edastamine ja vastuvõtmine=


	Creditinfosse saadetava faili nimi peab olema kujul:		Creditinfosse saadetava faili nimi peab olema kujul:
Line 27:		Line 27:
	** kui tegemist on vastusefailiga, siis on tegu päringu kellaajaga, et kergelt kokku viia päringut ja vastust. Vastuse genereerimise aeg on reeglina failis sees.		** kui tegemist on vastusefailiga, siis on tegu päringu kellaajaga, et kergelt kokku viia päringut ja vastust. Vastuse genereerimise aeg on reeglina failis sees.
	* <faililaiend> - Creditinfoga kokkulepitud failiformaat (csv/xml/xlsx/jne). Teatud juhtudel on mõistlik kokkulepituna rakendada ka zip/gzip kompressiooni.		* <faililaiend> - Creditinfoga kokkulepitud failiformaat (csv/xml/xlsx/jne). Teatud juhtudel on mõistlik kokkulepituna rakendada ka zip/gzip kompressiooni.


	= WSDL =		= WSDL =
Line 45:		Line 46:

	Alla laetavate failide nimekirja saab pärida funkstiooniga getDownloadQueue(). Kord alla laetud fail kaob nimekirjast, aga faili ID säilitamisel saab faili alla laadida ka hiljem.		Alla laetavate failide nimekirja saab pärida funkstiooniga getDownloadQueue(). Kord alla laetud fail kaob nimekirjast, aga faili ID säilitamisel saab faili alla laadida ka hiljem.


	== Meetodid ==		== Meetodid ==
Line 262:		Line 264:
	\| Faili staatust täpsustav info		\| Faili staatust täpsustav info
	\|}		\|}


	= Veakoodid =		= Veakoodid =
Line 308:		Line 311:

	Faili edastamiseks testserverisse tuleb lisada parameeter ''debug'' serveri aadressile, ehk 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'		Faili edastamiseks testserverisse tuleb lisada parameeter ''debug'' serveri aadressile, ehk 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'


	= Näidis pseudokoodina =		= Näidis pseudokoodina =



	<pre>		<pre>

Annika: /* Näidis PHP-s */

2023-05-05T11:56:37Z

Näidis PHP-s

← Older revision		Revision as of 14:56, 5 May 2023
Line 309:		Line 309:
	Faili edastamiseks testserverisse tuleb lisada parameeter ''debug'' serveri aadressile, ehk 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'		Faili edastamiseks testserverisse tuleb lisada parameeter ''debug'' serveri aadressile, ehk 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'

	= Näidis ~~PHP-s~~ =		= Näidis pseudokoodina =


	Programm laeb faili Creditinfo serverisse ning seejärel laeb sama faili alla. Lõpus kontrollitakse, kas üles ja alla laetud faili sisu on sama. Programmi põhimõte sobib KiDocExchange liidese testimiseks. Kui soovite maksehäire sisestamiseks mõeldud faili testida siis ärge kasutage silumismoodi.

	<pre>		<pre>
	~~<?php~~		/** DEFINE PARAMETERS */
	/**		$wsdl = 'http://services.krediidiinfo.ee/KiDocExchange.wsdl';
	* Example of uploading and downloading files using KiDocExchange interface.		$productionLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange';
	* @author Rait Kapp <rait@creditinfo.ee>		$testLocation = 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'; // same as production, but with added 'debug' parameter
	* @created 27.04.~~2007~~		$username = ''; // provided by Creditinfo
	*/		$password = ''; // provided by creditinfo
	$~~wsdl_url~~ = '~~http~~://services.krediidiinfo.ee/KiDocExchange~~.wsdl~~';		$connectionParameters = [
	$~~params~~ = ~~array(~~'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'		'location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug',
	, 'login' => 'username' ~~// <-- username. Make sure username is string type (PHP bug?).~~		'login' => 'username',
	, 'password' => 'password' ~~// <-- password~~		'password' => 'password'
	);		];
			$testFileContent = 'test file content';
	$~~client~~ = ~~new SoapClient($wsdl_url, $params)~~;		$testFileName = 'test_file_name.txt';

	// ~~Uploading file.~~		/** INIT CLIENT */
	$~~content~~ = '~~I am a little test file!~~';		$client = new SoapClient(
	$~~docID =~~ $~~client->startUpload(~~'~~test.txt~~');		$wsdl,
	~~$client-~~>~~uploadChunk(~~$~~docID~~, $~~content~~);		[
			'location' => IN_PRODUCTION_ENV ? $productionLocation : $testLocation,
			'login' => $username,
			'password' => $password
			]
			);

	$md5 = md5($~~content~~);		/** INIT FILE TRANSFER */
	$~~result~~ = $client->finishUpload($~~docID~~, $md5);		$fileId = $client->startUpload($testFileName);
	if ($~~result !~~= 0) {
	~~die("~~upload failed~~.! Error~~ code~~: {$result}\n");~~		/** SEND FILE CONTENT */
			$client->uploadChunk($fileId, $testFileContent); // no need to seperate content into multiple chunks unless file is extremely big

			/** FINISH UPLOAD */
			$md5 = md5($testFileContent); // md5 checksum to verify data integrity
			$reponseCode = $client->finishUpload($fileId, $md5);
			if ($reponseCode == 0) {
			// upload failed, check response code for reason
	}		}

	// ~~Downloading file~~		/** DOWNLOAD FILE */
			$fileId = 12345; // actual ID is aquired via getDownloadQueue response
			$fileName = 'test_file.txt'; // can be anything but highly suggest using same as in getDownloadQueue response
	$start = 0;		$start = 0;
	$~~count~~ = 512; // ~~can be a big number if you do not have~~ to ~~display~~ download progress.		$chunkSize = 512; // was useful 30 years ago with lower download speeds, to monitor download progress. today you can use a large number which should cover the response file in one go
	$~~data~~ = '';		$fileContent = '';
	while ($chunk = $client->downloadChunk($~~docID~~, $start, $~~count~~)) {		while ($chunk = $client->downloadChunk($fileId, $start, $chunkSize)) {
	$start += $~~count~~;		$start += $chunkSize;
	$~~data~~ .= $chunk;		$fileContent .= $chunk;
	}

	~~if ($content != $data) {~~
	~~echo "Something is not right!\n";~~
	~~} else {~~
	~~echo "We got back: {$data}\n"~~;
	}		}

	?>		saveFile($fileName, $fileContent);
	</pre>		</pre>

Annika: /* Failide edastamine ja vastuvõtmine */

2023-05-05T11:49:17Z

Failide edastamine ja vastuvõtmine

← Older revision		Revision as of 14:49, 5 May 2023
Line 8:		Line 8:

	= Failide edastamine ja vastuvõtmine=		= Failide edastamine ja vastuvõtmine=


	~~Faile saab Creditinfole edastada ja ka vastu võtta [[KiDocExchange]] SOAP liidese kaudu.~~


	Creditinfosse saadetava faili nimi peab olema kujul:		Creditinfosse saadetava faili nimi peab olema kujul:

	<pre>		<pre>
	req_<~~Creditinfo_toote_kood~~>_<~~kliendi_faili_id~~>.xml~~.gz~~		req_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
			nt. req_123456_mhr_20230505124518.xml
	</pre>		</pre>

			Creditinfo vastusfaili kuju (kui tegemist on vastust vajava tootega)
	* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
	* <kliendi_faili_id> - kliendi poolt määratud unikaalne id, millega eristatakse faile üksteisest. Näiteks faili genereerimise aeg.

	Creditinfo vastusfaili kuju:
	<pre>		<pre>
	resp_<~~Creditinfo_toote_kood~~>_<~~kliendi_faili_id~~>.gz		resp_<kliendikood>_<toote_kood>_<kuupäev+kellaaeg>.<faililaiend>
			nt. resp_123456_mhr_20230505124518.xml
	</pre>		</pre>

	* <~~Creditinfo_toote_kood~~> - Creditinfoga ~~kokkulepitud toode, mille alusel koostatakse vastus fail~~.		* <kliendikood> - Creditinfoga poolt jagatav väärtus.
	* <~~kliendi_faili_id~~> - ~~kliendi~~ poolt ~~määratud unikaalne id, millega eristatakse faile üksteisest~~. ~~Näiteks faili~~ genereerimise aeg.		* <toote_kood> - Creditinfoga poolt jagatav väärtus.
	~~Vastusfaili nimi ei vasta saadetud faili nimele krediidihaldusesse saadetud failide puhul. Põhjuseks asjaolu~~, et ~~maksehäired lisab krediidihaldur tööpäeva jooksul~~ ja ~~genereerib tagasisideraporti pärast seda~~.		* <kuupäev+kellaaeg> - Päringufaili genereerimise aeg. Formaat YYYYMMDDHHmmss. Näide: 2023-05-23 12:45:18 -> 20230523124518
			** kui tegemist on vastusefailiga, siis on tegu päringu kellaajaga, et kergelt kokku viia päringut ja vastust. Vastuse genereerimise aeg on reeglina failis sees.
			* <faililaiend> - Creditinfoga kokkulepitud failiformaat (csv/xml/xlsx/jne). Teatud juhtudel on mõistlik kokkulepituna rakendada ka zip/gzip kompressiooni.

	= WSDL =		= WSDL =

Andrus at 09:22, 1 April 2020

2020-04-01T09:22:59Z

← Older revision		Revision as of 12:22, 1 April 2020
Line 30:		Line 30:
	* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.		* <Creditinfo_toote_kood> - Creditinfoga kokkulepitud toode, mille alusel koostatakse vastus fail.
	* <kliendi_faili_id> - kliendi poolt määratud unikaalne id, millega eristatakse faile üksteisest. Näiteks faili genereerimise aeg.		* <kliendi_faili_id> - kliendi poolt määratud unikaalne id, millega eristatakse faile üksteisest. Näiteks faili genereerimise aeg.
			Vastusfaili nimi ei vasta saadetud faili nimele krediidihaldusesse saadetud failide puhul. Põhjuseks asjaolu, et maksehäired lisab krediidihaldur tööpäeva jooksul ja genereerib tagasisideraporti pärast seda.

	= WSDL =		= WSDL =