lt:xmlcore
Skirtumai
Čia matote skirtumus tarp pasirinktos versijos ir esamo dokumento.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
lt:xmlcore [2020/07/28 09:17] – [2.4. Pavyzdys PHP kalba] ieva | lt:xmlcore [2022/04/07 09:40] – [3. Atsakymų kodai] modesta | ||
---|---|---|---|
Linija 1: | Linija 1: | ||
======Bendras XML duomenų mainų sąsajos aprašymas====== | ======Bendras XML duomenų mainų sąsajos aprašymas====== | ||
+ | |||
+ | ====Bendra informacija==== | ||
+ | |||
+ | Jei pageidaujama, | ||
Integracijos principai: | Integracijos principai: | ||
- | | + | |
- | * Duomenų koduotė UTF-8; | + | * Duomenų koduotė UTF-8; |
- | * Metodas informacijai pasiekti HTTPS (sertifikatas viešai pripažįstamas); | + | * Metodas informacijai pasiekti HTTPS (sertifikatas viešai pripažįstamas); |
- | * GET metodas naudojamas duomenims gauti; | + | * GET metodas naudojamas duomenims gauti; |
- | * POST metodas yra naudojamas duomenis išsiųsti; | + | * POST metodas yra naudojamas duomenis išsiųsti; |
- | * Duomenų apsikeitimą visuomet inicijuoja išorinė šalis, nepriklausomai nuo apsikeitimo krypties; | + | * Duomenų apsikeitimą visuomet inicijuoja išorinė šalis, nepriklausomai nuo apsikeitimo krypties; |
- | * Į POST užklausą atsakoma sinchronizuotu XML pranešimu, kurio apdorojimas gali daryti įtaką sėkmingam procesui; | + | * Į POST užklausą atsakoma sinchronizuotu XML pranešimu, kurio apdorojimas gali daryti įtaką sėkmingam procesui; |
- | * Duomenų struktūra turi atitikti paruoštą XSD schemą. Pageidaujama reikšmes siųsti atributuose. | + | * Duomenų struktūra turi atitikti paruoštą XSD schemą. Pageidaujama reikšmes siųsti atributuose. |
+ | * Directo dokumentų numerių tipas yra integer, tai reiškia, kad didžiausias galimas skaičius yra 2147483647. | ||
+ | * Tuščios (NULL) reikšmės nebus įtraukiamos į XML su lauko pavadinimu. Tą patį darykite ir siųsdami duomenis į Directo - praleiskite laukus, kuriuose turi būti tuščių (NULL) reikšmių. Reikėtų vengti siųsti laukus su tuščia reikšme, kaip pavyzdžiui: | ||
+ | **Endpoint URL:** [[https:// | ||
- | * **Endpoint URL:** https:// | ||
- | ==== 2.1. Informacijos pasiėmimas iš Directo (OUT) ==== | + | |
+ | ==== 1. Prieiga prie serviso ==== | ||
+ | |||
+ | Serviso nuorodos yra pasiekiamos '' | ||
+ | <code xml>< | ||
+ | |||
+ | Pavyzdys naudojant cURL: | ||
+ | <code bash> | ||
+ | curl -v -d " | ||
+ | </ | ||
+ | |||
+ | |||
+ | ====2. Pavydžiai ==== | ||
+ | Toliau pateikti pavyzdžiai turi būti laikomi tik apytiksliais ir svarbu atsiminti, kad konkrečioje kuriamoje sąsajoje beveik tikrai bus naudojamos kitokios **schemos, URL, parametrai, apribojimai, | ||
+ | Norėdami išbandyti, naudokite šią formą: [[https:// | ||
+ | |||
+ | |||
+ | === 2.1. Informacijos pasiėmimas iš Directo (OUT) === | ||
GET metodo atveju bent 3 parametrai turi būti nurodyti: | GET metodo atveju bent 3 parametrai turi būti nurodyti: | ||
- | * get=1 | + | * '' |
- | * what=SERVISO_KODAS | + | * '' |
- | * key=SUGENERUOTAS_RAKTAS | + | * '' |
Papildomi parametrai yra derinami individualiai pagal poreikį, integracijos derinimo metu. | Papildomi parametrai yra derinami individualiai pagal poreikį, integracijos derinimo metu. | ||
+ | Šiame pavyzdyje naudojami '' | ||
- | Šio pavyzdžio atveju yra naudjamas **what** = " | + | Užklausa prekėms pagal išsaugojimo datą (ts = Time stamp): [[https://login.directo.ee/ |
+ | Laiko filtras taip pat gali naudoti laiką taip: & ts = 01.03.2021 12:30 / & ts = 01.03.2021%2012: | ||
Užklausos pavyzdys, norint gauti visų prekių sąrašą: | Užklausos pavyzdys, norint gauti visų prekių sąrašą: | ||
- | + | https:// | |
- | https:// | + | |
Užklausos pavyzdys, norint gauti konkrečios prekės informaciją: | Užklausos pavyzdys, norint gauti konkrečios prekės informaciją: | ||
+ | https:// | ||
- | https:// | + | == Pirkėjo išvestis (OUT): |
- | ==== 2.2. Informacijos siuntimas į Directo (IN) ==== | + | [[https:// |
- | Duomenys siunčiami naudojant POST metodą. | + | Filtro parinkčių pavyzdžiai: |
- | Užpildomi trys formos kintamieji: | + | == Sandėlio kiekio išvestis (OUT): == |
- | * put=1 | + | |
- | * what=INVOICE | + | |
- | * xmldata=<? | + | |
+ | https:// | ||
- | Šis siuntimas naudojamas, | + | Filtro parinkčių |
- | Šiame pavyzdyje nurodyti URL ir XML pvz. yra visiškai išgalvoti ir negali būti naudojami testavimui. Testavimas visada atliekamas realiame procese. | ||
- | Tarkime, kad šiuo atveju URL pvz. https:// | + | === 2.3. Informacijos siuntimas į Directo (IN) === |
- | Pavyzdinio serviso XSD schemą: | + | Duomenys siunčiami naudojant '' |
+ | |||
+ | Užpildomi formos kintamieji: | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | * '' | ||
+ | |||
+ | Įvesties sąsajoje XML turi būti išsiųstas adresu [[https:// | ||
+ | |||
+ | <wrap important> | ||
+ | Šiame pavyzdyje nurodyti URL ir XML pavyzdžiai yra visiškai išgalvoti ir negali būti naudojami testavimui. Testavimas visada atliekamas realiame procese. | ||
+ | </ | ||
+ | |||
+ | **Praktinis pavyzdys** | ||
+ | |||
+ | Tokio tipo įvestis naudojama, pavyzdžiui, | ||
+ | |||
+ | Tarkime, kad šiuo atveju URL pvz. [[https:// | ||
+ | |||
+ | Pavyzdinio serviso XSD schemą: | ||
Pavyzdinis XML: | Pavyzdinis XML: | ||
- | < | + | < |
<?xml version=" | <?xml version=" | ||
< | < | ||
- | < | + | <invoice InvoiceNr=" |
InvoiceDate=" | InvoiceDate=" | ||
< | < | ||
Linija 68: | Linija 110: | ||
</ | </ | ||
- | Servisas | + | Servisas |
Pavyzdžiui įkėlimas buvo sėkmingas ir Directo sąskaitos dokumentui priskyrė numerį 123: | Pavyzdžiui įkėlimas buvo sėkmingas ir Directo sąskaitos dokumentui priskyrė numerį 123: | ||
- | < | + | < |
<?xml version=" | <?xml version=" | ||
< | < | ||
Linija 83: | Linija 125: | ||
Pavyzdžiui sąskaita numeriu 123 buvo atmesta, nes Directo sistemoje jau egzistavo sąskaitos dokumentas tokiu numeriu: | Pavyzdžiui sąskaita numeriu 123 buvo atmesta, nes Directo sistemoje jau egzistavo sąskaitos dokumentas tokiu numeriu: | ||
- | < | + | < |
<?xml version=" | <?xml version=" | ||
< | < | ||
Linija 92: | Linija 134: | ||
Vienu siuntimu galima įkelti kelias sąskaitas iš karto. Tokiu atveju rezultatas turi būti grąžinamas kiekvienai sąskaitai: | Vienu siuntimu galima įkelti kelias sąskaitas iš karto. Tokiu atveju rezultatas turi būti grąžinamas kiekvienai sąskaitai: | ||
- | < | + | < |
<?xml version=" | <?xml version=" | ||
< | < | ||
Linija 100: | Linija 142: | ||
</ | </ | ||
- | :!: Svarbu sulaukti atsakymo apie sėkmingą įkėlimą. Jeigu tokio rezultato nesulaukiama arba yra gaunama klaida, siuntimą reikia pakartoti ne anksčiau kaip po minutės. | + | <wrap important> |
+ | Svarbu sulaukti atsakymo apie sėkmingą įkėlimą. Jeigu tokio rezultato nesulaukiama arba yra gaunama klaida, siuntimą reikia pakartoti ne anksčiau kaip po minutės. | ||
+ | </ | ||
- | ==== 2.3. HTML forma ==== | + | **Pirkėjo įvesties sąsaja: |
+ | |||
+ | Duomenys aprašyti schemoje [[https:// | ||
+ | |||
+ | <code xml> | ||
+ | <? | ||
+ | < | ||
+ | < | ||
+ | </ customer > | ||
+ | </ customers > | ||
+ | </ | ||
+ | |||
+ | === 2.4. HTML forma === | ||
Parametrai, kuriuos reikia nurodyti: | Parametrai, kuriuos reikia nurodyti: | ||
- | * **What** – webserviso | + | * **What** – web serviso |
* **Put** – statinis. Visada „1“ jei tai importas į Directo. | * **Put** – statinis. Visada „1“ jei tai importas į Directo. | ||
* **Get** - statinis. Visada „1“ jei tai eksportas iš Directo. | * **Get** - statinis. Visada „1“ jei tai eksportas iš Directo. | ||
+ | * **Key** - web serviso autorizacijos raktas. | ||
* **Xmldata** – dinaminis. Laukus reiktų derinti, kadangi servisas būtų programuojamas individualiai pagal poreikį. | * **Xmldata** – dinaminis. Laukus reiktų derinti, kadangi servisas būtų programuojamas individualiai pagal poreikį. | ||
Linija 113: | Linija 170: | ||
Pavyzdinė užsakymo forma: | Pavyzdinė užsakymo forma: | ||
- | < | + | < |
- | <form method=" | + | <form method=" |
<input name=" | <input name=" | ||
Linija 120: | Linija 177: | ||
<input name=" | <input name=" | ||
- | < | + | <input name=" |
+ | |||
+ | < | ||
<input TYPE=" | <input TYPE=" | ||
Linija 128: | Linija 187: | ||
- | ==== 2.4. Pavyzdys PHP kalba ==== | + | === 2.5. Pavyzdys PHP kalba === |
- | Į servisą kreiptis | + | Į servisą |
**OUT** | **OUT** | ||
- | < | + | < |
- | $url = ' | + | $url = ' |
+ | $key = ' | ||
$ch = curl_init(); | $ch = curl_init(); | ||
Linija 141: | Linija 201: | ||
curl_setopt($ch, | curl_setopt($ch, | ||
curl_setopt($ch, | curl_setopt($ch, | ||
- | curl_setopt($ch, | + | curl_setopt($ch, |
+ | curl_setopt($ch, | ||
+ | |||
$result = curl_exec($ch); | $result = curl_exec($ch); | ||
Linija 152: | Linija 213: | ||
print '< | print '< | ||
- | + | print_r($data); | |
- | foreach ($data->items->item as $item) { | + | foreach ($data-> |
- | print $item[' | + | print |
- | foreach ($item-> | + | foreach ($item-> |
- | print chr(9) . $df[' | + | print chr(9) . $df[' |
- | } | + | } |
} | } | ||
</ | </ | ||
Linija 163: | Linija 224: | ||
**IN** | **IN** | ||
- | < | + | < |
- | $xmldata | + | $url = 'https:// |
- | < | + | $key = ' |
+ | |||
+ | $xmldata = <<< | ||
+ | <?xml version=" | ||
+ | <invoice InvoiceNr=" | ||
InvoiceDate=" | InvoiceDate=" | ||
< | < | ||
Linija 171: | Linija 236: | ||
<line ProductID=" | <line ProductID=" | ||
</ | </ | ||
- | </ | + | </ |
- | + | XML; | |
- | $url = ' | + | |
$ch = curl_init(); | $ch = curl_init(); | ||
+ | |||
curl_setopt($ch, | curl_setopt($ch, | ||
curl_setopt($ch, | curl_setopt($ch, | ||
Linija 181: | Linija 247: | ||
curl_setopt($ch, | curl_setopt($ch, | ||
curl_setopt($ch, | curl_setopt($ch, | ||
- | + | curl_setopt($ch, | |
- | curl_setopt($ch, | + | |
$result = curl_exec($ch); | $result = curl_exec($ch); | ||
+ | curl_close($ch); | ||
- | print '<textarea cols=80 rows=10>' | + | echo '<pre>'; |
- | curl_close($ch); | + | print '</ |
</ | </ | ||
+ | |||
+ | === 2.6. Postman === | ||
+ | [[https:// | ||
+ | |||
+ | ==== 3. Atsakymų kodai ==== | ||
+ | |||
+ | | **kodas** |**Atsakymo tekstas** |**Pastaba**|**Paaiškinimas**|Description | | ||
+ | | 0 | Created | |Dokumentas sėkmingai sukurtas | Document successfully created| | ||
+ | | 0 | Updated | (if document update feature is used) | Dokumentas sėkmingai atnaujintas (jei naudojamas automatinis dokumentų atnaujinimas)| | ||
+ | | 0 | Confirmed | (if auto document confirmation is used) | Dokumentas sėkmingai patvirtintas (jei naudojamas automatinis dokumentų patvirtinimas)| | ||
+ | | | | ||
+ | | 2 | Too secure location | | Informuokite Directo| | ||
+ | | 3 | Database is moved to a new server. Takes about 15 minutes | |Duomenų bazė perkelta į kitą serverį, prašome palaukti 15 minučių| | ||
+ | | 4 | Database is closed - user count is zero | |Duomenų bazė uždaryta | Database closed| | ||
+ | | 5 | Unauthorized | | Neteisingas raktas ar neteisingai paduotas raktas (key)|Incorrect key or incorrect given key| | ||
+ | | 6 | Invalid user given | | Neegzistuojantis darbuotojas| | ||
+ | | 7 | Invalid IP source given | | Neegzistuojantis arba apribotas darbuotojas| Non-existent or restricted user| | ||
+ | | 8 | Invalid xml given: ... | | Klaidingas ar neteisingos struktūros XML (skaityri pranešimo tekstą)|Invalid, | ||
+ | | 9 | Error on import: ... | | Klaida susijusi su procedūra, informuokite Directo| | ||
+ | | | An error is related to the procedure, please inform Directo| | ||
+ | | 11 | Duplicate | | Toks dokumentas jau egzistuoja| Document already exists| | ||
+ | | 12 | Missing document identificator | | Nenustatytas dokumento unikalus laukas|Document unique field has not been set | | ||
+ | | 13 | Missing customer code / Missing customer regno | (if code is not used) | Nenusiųstas arba nenustatytas pirkėjo unikalus laukas| | ||
+ | | 14 | Update not allowed | (if document is commited or has related documents) | Negalima atnaujinti dokumento (greičiausiai su dokumentu yra kitų susijusių dokumentų| | ||
+ | | | | ||
+ | | 17 | Document insert failed | ||
+ | | 18 | uniqueid field not found | (needs to be set up correctly in transport parameters) | Nenustatytas unikalus laukas| | ||
+ | | 19 | Removal of document not allowed | | Dokumento ištrinti nepavyko (gali būti patvirtintas, | ||
+ | | 29 | Not confirmed: ... | (if auto document confirmation is used) | Dokumentas nepatvirtintas, | ||
+ | | | | ||
+ | | 30 | Created | (creation of related document like customer, payment etc.) | Antrinis dokumentas sukurtas sėkmingai| | ||
+ | | 30 | Updated | (update of related document like customer, payment etc.) | Antrinis dokumentas atnaujintas sėkmingai | | ||
+ | | 30 | Confirmed | (confirmed related document like payment etc.) | Antrinis dokumentas patvirtintas sėkmingai| | ||
+ | | 31 | ... not found | (prerequisite of creation of related document like customer, payment etc. not met) |(item IN) klaidos priežastis nurodyta atsakyme | | ||
+ | | 39 | ... not confirmed: ... | (if auto document confirmation for related document is in use) | Antrinio dokumento patvirtinti nepavyko, priežastis nurodyrta atsakyme| | ||
+ | | | | ||
+ | | 99 | No processable XML data found for document: |
lt/xmlcore.txt · Keista: 2023/09/15 15:27 vartotojo jaroslav