KiDocExchange en - Revision history

Annika: /* Example in pseudo code */

2024-02-05T19:16:39Z

Example in pseudo code

← Older revision		Revision as of 22:16, 5 February 2024
Line 379:		Line 379:
	);		);

	/** ~~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: /* Methods */

2024-02-05T19:16:17Z

Methods

@@ Line 67: / Line 67: @@
 | Unique file identification number in Creditinfo server.
 |}
 === uploadChunk ===

Annika: /* Methods */

2024-01-03T11:35:56Z

Methods

@@ Line 139: / Line 139: @@
 | xs:base64Binary
 | File content
 |}

Annika: /* Example in pseudo code */

2024-01-03T11:27:21Z

Example in pseudo code

← Older revision		Revision as of 14:27, 3 January 2024
Line 329:		Line 329:
	$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: /* Methods */

2024-01-03T11:20:42Z

Methods

@@ Line 118: / Line 118: @@
 | xs:integer
 | If 0 then file upload succeeded. If negative then there was an error. See Error Codes for more information.
 |}

Annika: /* Example in PHP */

2023-05-05T11:57:14Z

Example in PHP

← Older revision		Revision as of 14:57, 5 May 2023
Line 272:		Line 272:


	= Example in ~~PHP~~ =		= Example in pseudo code =

	<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 at 11:53, 5 May 2023

2023-05-05T11:53:53Z

← Older revision		Revision as of 14:53, 5 May 2023
Line 9:		Line 9:

	KiDocExchange is a web service for uploading files into Creditinfo server. Web Service description can be found on http://services.krediidiinfo.ee/KiDocExchange.wsdl.		KiDocExchange is a web service for uploading files into Creditinfo server. Web Service description can be found on http://services.krediidiinfo.ee/KiDocExchange.wsdl.


			== Filename guide for sending and receiving ==

			Creditinfo file transfer file name guide for request file:
			<pre>
			req_<client_code>_<product_code>_<date+time>.<file_extension>
			nt. req_123456_mhr_20230505124518.xml
			</pre>

			Creditinfo file name for request file (if necessary for product):
			<pre>
			resp_<client_code>_<product_code>_<date+time>.<file_extension>
			nt. req_123456_mhr_20230505124518.xml
			</pre>

			* <client_code> - Supplied by Creditinfo.
			* <product_code> - Supplied by Creditinfo.
			* <date+time> - Datetime of file generation. Format YYYYMMDDHHmmss. Example: 2023-05-23 12:45:18 -> 20230523124518
			** in response file this is request file generation time to easily match response to request via file name. Actual response generation time is usually inside the file.
			* <file_extension> - File extension agreed with Creditinfo (csv/xml/xlsx/jne). In some cases it can also make sense to use zip/gzip compression.


	== Sequence Diagram ==		== Sequence Diagram ==

Vlads: /* Sequence Diagram */

2016-12-27T15:01:48Z

Sequence Diagram

← Older revision		Revision as of 18:01, 27 December 2016
Line 15:		Line 15:

	[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]		[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]

			and to download

			[[Image:Download_diagram.png]]


			List of available files for download can be requested using getDownloadQueue() function. Once downloaded successfully the file is removed from the list. It is still possible to download the file later on if you keep the file id.

	== Methods ==		== Methods ==

Paavo at 11:49, 6 December 2016

2016-12-06T11:49:00Z

← Older revision		Revision as of 14:49, 6 December 2016
Line 8:		Line 8:
	== Introduction ==		== Introduction ==

	KiDocExchange is a web service for uploading files into ~~Krediidiinfo~~ server. Web Service description can be found on http://services.krediidiinfo.ee/KiDocExchange.wsdl.		KiDocExchange is a web service for uploading files into Creditinfo server. Web Service description can be found on http://services.krediidiinfo.ee/KiDocExchange.wsdl.

	== Sequence Diagram ==		== Sequence Diagram ==
Line 36:		Line 36:
	\| docID		\| docID
	\| xs:integer		\| xs:integer
	\| Unique file identification number in ~~Krediidiinfo~~ server.		\| Unique file identification number in Creditinfo server.
	\|}		\|}

Line 93:		Line 93:
	=== getDownloadQueue ===		=== getDownloadQueue ===

	The list of files waiting for client to download them from ~~Krediidiinfo~~ server.		The list of files waiting for client to download them from Creditinfo server.

	{\| style="border-style: solid; border-width: 1px"		{\| style="border-style: solid; border-width: 1px"
Line 164:		Line 164:
	\| colspan="3" \|		\| colspan="3" \|
	\| align="right" \| -1		\| align="right" \| -1
	\| Unknown error. Contact ~~Krediidiinfo~~ for more information. You might get usefull information with getStatusMsg method.		\| Unknown error. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
	\|-\|-		\|-\|-
	\| colspan="3" \|		\| colspan="3" \|
Line 172:		Line 172:
	\| colspan="3" \|		\| colspan="3" \|
	\| align="right" \| -xxxxx		\| align="right" \| -xxxxx
	\| File processing failed. Contact ~~Krediidiinfo~~ for more information. You might get usefull information with getStatusMsg method.		\| File processing failed. Contact Creditinfo for more information. You might get usefull information with getStatusMsg method.
	\|}		\|}

Line 249:		Line 249:
	/**		/**
	* Example of uploading and downloading files using KiDocExchange interface.		* Example of uploading and downloading files using KiDocExchange interface.
	* @author Rait Kapp <rait@~~krediidiinfo~~.ee>		* @author Rait Kapp <rait@creditinfo.ee>
	* @created 27.04.2007		* @created 27.04.2007
	*/		*/

Julia at 11:34, 7 October 2016

2016-10-07T11:34:30Z

← Older revision		Revision as of 14:34, 7 October 2016
Line 236:		Line 236:
	</tr>		</tr>
	</table>		</table>


			= Debugging =

			Developers can use a test server for file uploading. For that they should add a parameter ''debug'' to the server url. The url would be 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'.