KiDocExchange en

2008-09-19T11:26:18Z

Mart: New page: {| align="right" | 30px eesti keeles |} = KiDocExchange Web Service = == Introduction == KiDocExchange is a web service for uploa...

{| align="right"
| [[Image:Flag of Estonia.svg|border|30px]] [[KiDocExchange|eesti keeles]]
|}

= KiDocExchange Web Service =

== 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.

== Sequence Diagram ==

Next squence diagram illustrates how to use KiDocExchange to upload files.

[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]

== Methods ==

=== startUpload ===

Starts and initializes file upload.

{| style="border-style: solid; border-width: 1px;"
!
! Name
! Type
! Description
|-
| Input Parameter:
| fileName
| xs:string
| The name of file
|-
| Output Parameter:
| docID
| xs:integer
| Unique file identification number in Krediidiinfo server.
|}

=== uploadChunk ===

Uploads and appends next chunk of data. Servers can send data in one chunk. Several chunks are needed when upload process is slow and there are a progress feedback needed (desktop application).

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| chunk
| xs:base64Binary
| Next chunk of data
|-
| Output Parameters:
|
|
| None
|}

=== finishUpload ===

Finishes file upload.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
|
| md5
| xs:string
| MD5 checksum of uploaded file
|-
| Output Parameters:
| errorCode
| xs:integer
| If 0 then file upload succeeded. If negative then there was an error. See Error Codes for more information.
|}

=== getStatusCode ===

Returns the status code of uploaded file

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! colspan="2" style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| colspan="2" |File identification number
|-
| Output Parameters:
| status_code
| xs:integer
| colspan="2" | File status code:
|-
| colspan="3" |
| align="right" | 0
| File has been processed
|-
| colspan="3" |
| align="right" | 2
| Uploading in progress
|-
| colspan="3" |
| align="right" | 3
| File is in processing
|-
|-
| colspan="3" |
| align="right" | 4
| File was successfully uploaded and is waiting for processing
|-
| colspan="3" |
| align="right" | -1
| Unknown error. Contact Krediidiinfo for more information. You might get usefull information with getStatusMsg method.
|-|-
| colspan="3" |
| align="right" | -10003
| MD5 check failed
|-
| colspan="3" |
| align="right" | -xxxxx
| File processing failed. Contact Krediidiinfo for more information. You might get usefull information with getStatusMsg method.
|}

=== getStatusMsg ===

Returns the status message of uploaded file.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Name
! style="text-align: left;" | Type
! style="text-align: left;" | Description
|-
| Input Parameters:
| docID
| xs:integer
| File identification number
|-
| Output Parameters:
| statusMsg
| xs:string
| Status message of the file
|}

== Error Codes ==

<table>
<tr>
<td>Code</td>
<td>Description</td>
</tr>
<tr>
<td>0</td>
<td>Success</td>
</tr>
<tr>
<td></td>
<td>Request was processed successfully.</td>
</tr>
<tr>
<td>-10001</td>
<td>Access denied</td>
</tr>
<tr>
<td></td>
<td>You are trying to access file owned by somebody else.</td>
</tr>
<tr>
<td>-10002</td>
<td>File does not exists</td>
</tr>
<tr>
<td></td>
<td>You are using file identification that does not exist</td>
</tr>
<tr>
<td>-10003</td>
<td>MD5 failure</td>
</tr>
<tr>
<td></td>
<td>Your sent MD5 does not match MD5 calculated by server</td>
</tr>
</table>

KiDocExchange

2008-09-19T11:24:37Z

Mart:

{| align="right"
| [[Image:Flag of the United Kingdom.svg|border|30px]] [[KiDocExchange__en|In English]]
|}

= Tutvustus =

KiDocExchange on Krediidiinfo veebiteenus failide saatmiseks Krediidiinfosse.

= WSDL =

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

= Järgnevusdiagramm =

Järgnevusdiagrammil on näidatud KiDocExchange meetodite väljakutsumise järjekorrad.

[[Image:KiDocExchange_Upload_Sequence_Diagram.jpg]]

== Meetodid ==

=== startUpload ===

Failide üleslaadimise initsialiseerimine.

{| style="border-style: solid; border-width: 1px;"
!
! Nimi
! Tüüp
! Kirjeldus
|-
| Sisendparameeter:
| fileName
| xs:string
| Faili nimi
|-
| Väljundparameeter:
| docID
| xs:integer
| Unikaalne faili id Krediidiinfo serveris.
|}

=== uploadChunk ===

Laetakse serverisse ning lisatakse juba serveris olevale failile lõppu osa failist. Kliendid võivad kogu faili saata ka ühe osana. Failide jupitamist on soovitav kasutada desktop lahendustes suurte failide saatmisel.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| Sisendparameetrid:
| docID
| xs:integer
| Faili identifikaator.
|-
|
| chunk
| xs:base64Binary
| Järgmine faili osa.
|-
| Väljundparameeter:
|
|
| None
|}

=== finishUpload ===

Faili üleslaadimise lõpetamine.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| Sisendparameetrid:
| docID
| xs:integer
| Faili identifikaator
|-
|
| md5
| xs:string
| Üles laetud faili MD5 kontrollsumma.
|-
| Väljundparameeter:
| errorCode
| xs:integer
| Kui 0, siis faili üleslaadimine õnnestus. Kui negatiivne, siis tekkis mingi viga (vt veakoodide).
|}

=== downloadChunk ===

Faili alamosa allalaadimine Krediidiinfo failiserverist.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| Sisendparameetrid:
| docID
| xs:integer
| Faili identifikaator
|-
|
| start
| xs:integer
| Positsioon failis, millest alates andmeid alla laetakse (positsiooni lugemine algab nullist)
|-
|
| count
| xs:integer
| Alla laetava tüki suurus baitides.
|-
| Väljundparameeter:
| chunk
| xs:base64Binary
| Faili alamosa
|}

=== getDownloadQueue ===

Krediidiinfo serveris kliendi poolt allalaadimist ootavate failide loetelu.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| Väljundparameeter:
| queue
| DownloadQueueArray
| Massiiv DownloadQueueType tüüpi elementidest
|}

DownloadQueueType on assiotsiatiivne massiiv, millel on järgmised elemendid:

{| style="border-style: solid; border-width: 1px"
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| docID
| xs:integer
| faili id
|-
| fileName
| xs:string
| faili nimi
|}

=== getStatusCode ===

Tagastatakse üles laetud faili staatus serveris.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! colspan="2" style="text-align: left;" | Kirjeldus
|-
| Sisendparameeter:
| docID
| xs:integer
| colspan="2" |Faili identifikaator
|-
| Output Parameters:
| status_code
| xs:integer
| colspan="2" | Faili staatuse kood:
|-
| colspan="3" |
| align="right" | 0
| Fail on töödeldud
|-
| colspan="3" |
| align="right" | 2
| Toimub faili üles laadimine
|-
| colspan="3" |
| align="right" | 3
| Toimub faili töötlemine
|-
|-
| colspan="3" |
| align="right" | 4
| Fail on edukalt üles laetud ning ootab töötlemist
|-
| colspan="3" |
| align="right" | -1
| Tundmatu viga. Täpsema info saamiseks võtke ühendust tehnilise teoga. Rohkem infot vea teate kohta võib saada meetodiga getStatusMsg.
|-|-
| colspan="3" |
| align="right" | -10003
| MD5 kontroll ebaõnnestus. Kliendi saadetud MD5 kontrollsumma ei langenud kokku serveri poolt arvutatud MD5 kontrollsummaga.
|-
| colspan="3" |
| align="right" | -xxxxx
| Faili töötlemine ebaõnnestus. Täpsema info saamiseks võta ühendust tehnilise toega. Rohkem infot vea teate kohta võib saada meetodiga getStatusMsg.
|}

=== getStatusMsg ===

Tagastatakse staatust täpsustav info.

{| style="border-style: solid; border-width: 1px"
!
! style="text-align: left;" | Nimi
! style="text-align: left;" | Tüüp
! style="text-align: left;" | Kirjeldus
|-
| Sisendparameeter:
| docID
| xs:integer
| Faili identifikaator
|-
| Väljundparameeter:
| statusMsg
| xs:string
| Faili staatust täpsustav info
|}

= Veakoodid =

<table>
<tr>
<td>Kood</td>
<td>Kirjeldus</td>
</tr>
<tr>
<td>0</td>
<td>Success</td>
</tr>
<tr>
<td></td>
<td>Päringu töötlus õnnestus.</td>
</tr>
<tr>
<td>-10001</td>
<td>Access denied</td>
</tr>
<tr>
<td></td>
<td>Üritatakse pöörduda faili poole, mis kuulub kellelegi teisele.</td>
</tr>
<tr>
<td>-10002</td>
<td>File does not exists</td>
</tr>
<tr>
<td></td>
<td>Kasutati faili identifikaatorit, mida ei eksisteeri.</td>
</tr>
<tr>
<td>-10003</td>
<td>MD5 failure</td>
</tr>
<tr>
<td></td>
<td>Kliendi saadetud MD5 ei lange kokku serveri poolt arvutatud MD5-ga</td>
</tr>
</table>

= Näidis PHP-s =

Programm laeb faili Krediidiinfo 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.

NB! Failide üles- ja allalaadimine toimub silumismoodis (SOAP serveri urli lõpus on parameeter ''debug''. Kõik katsetused teha silumise moodis).

<pre>
<?php
/**
* Example of uploading and downloading files using KiDocExchange interface.
* @author Rait Kapp <rait@krediidiinfo.ee>
* @created 27.04.2007
*/
$wsdl_url = 'http://www.krediidiinfo.ee/services/KiDocExchange.wsdl';
$params = array('location' => 'https://services.krediidiinfo.ee/soap.php?name=KiDocExchange&debug'
, 'login' => 'username' // <-- username. Make sure username is string type (PHP bug?).
, 'password' => 'password' // <-- password
, 'proxy_host' => 'cache.neti.ee'
, 'proxy_port' => 8080
);

$client = new SoapClient($wsdl_url, $params);

// Uploading file.
$content = 'I am a little test file!';
$docID = $client->startUpload('test.txt');
$client->uploadChunk($docID, $content);

$md5 = md5($content);
$result = $client->finishUpload($docID, $md5);
if ($result != 0) {
die("upload failed.! Error code: {$result}\n");
}

// Downloading file
$start = 0;
$count = 512; // can be a big number if you do not have to display download progress.
$data = '';
while ($chunk = $client->downloadChunk($docID, $start, $count)) {
$start += $count;
$data .= $chunk;
}

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

?>
</pre>

services.krediidiinfo.ee - User contributions [en]

KiDocExchange en

KiDocExchange