Čia matote skirtumus tarp pasirinktos versijos ir esamo dokumento.
Both sides previous revision Previous revision Next revision | Previous revision Next revision Both sides next revision | ||
lt:xmlcore [2021/12/16 16:10] ignas [2.2. Informacijos pasiėmimas iš Directo (OUT)] |
lt:xmlcore [2022/04/08 13:28] modesta [3. Atsakymų kodai] |
||
---|---|---|---|
Linija 32: | Linija 32: | ||
- | ==== Pavydžiai ==== | + | ====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, žinutės atsakymai ir raktai** nei pateiktos pavyzdyje. Jokiu būdu negarantuojama, kad šie URL iš tikrųjų atitiks užklausą. Jei užklausos metu duomenys yra gaunami, jie yra 100% fiktyvūs ir nesusiję su jokių tikrų įmonių duomenimis. | 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, žinutės atsakymai ir raktai** nei pateiktos pavyzdyje. Jokiu būdu negarantuojama, kad šie URL iš tikrųjų atitiks užklausą. Jei užklausos metu duomenys yra gaunami, jie yra 100% fiktyvūs ir nesusiję su jokių tikrų įmonių duomenimis. | ||
Norėdami išbandyti, naudokite šią formą: [[https://login.directo.ee/xmlcore/demo_ee/webupload.html]] | Norėdami išbandyti, naudokite šią formą: [[https://login.directo.ee/xmlcore/demo_ee/webupload.html]] | ||
Linija 40: | Linija 40: | ||
GET metodo atveju bent 3 parametrai turi būti nurodyti: | GET metodo atveju bent 3 parametrai turi būti nurodyti: | ||
- | * **get**=1 | + | * ''get=1'' |
- | * **what**=SERVISO_KODAS | + | * ''what=SERVISO_KODAS'' |
- | * **key**=SUGENERUOTAS_RAKTAS | + | * ''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 **what=item** ir **get**=1. Visi filtrai galimi, jei schemoje yra atitinkamas laukas. Pavyzdžiui, "class", "code", "barcode", "supplier", "supplieritem", "closed", "ts" straipsnių aprašomoji struktūros schema: [[https://login.directo.ee/xmlcore/demo_ee /ws_artiklid.xsd]] | + | Šiame pavyzdyje naudojami ''what=item'' ir ''get=1''. Visi filtrai galimi, jei schemoje yra atitinkamas laukas. Pavyzdžiui, "class", "code", "barcode", "supplier", "supplieritem", "closed", "ts" straipsnių aprašomoji struktūros schema: [[https://login.directo.ee/xmlcore/demo_ee /ws_artiklid.xsd]] |
Užklausa prekėms pagal išsaugojimo datą (ts = Time stamp): [[https://login.directo.ee/xmlcore/demo_ee/xmlcore.asp?what=item&get=1&ts=01.01.2021]] | Užklausa prekėms pagal išsaugojimo datą (ts = Time stamp): [[https://login.directo.ee/xmlcore/demo_ee/xmlcore.asp?what=item&get=1&ts=01.01.2021]] | ||
Linija 53: | Linija 53: | ||
Užklausos pavyzdys, norint gauti visų prekių sąrašą: | Užklausos pavyzdys, norint gauti visų prekių sąrašą: | ||
- | |||
https://login.directo.ee/xmlcore/demo_ee/xmlcore.asp?get=1&what=item | https://login.directo.ee/xmlcore/demo_ee/xmlcore.asp?get=1&what=item | ||
Užklausos pavyzdys, norint gauti konkrečios prekės informaciją: | Užklausos pavyzdys, norint gauti konkrečios prekės informaciją: | ||
- | |||
https://login.directo.ee/xmlcore/demo_ee/xmlcore.asp?get=1&what=item&code=0000 | https://login.directo.ee/xmlcore/demo_ee/xmlcore.asp?get=1&what=item&code=0000 | ||
Linija 73: | Linija 71: | ||
- | ==== 2.3. Informacijos siuntimas į Directo (IN) ==== | + | === 2.3. Informacijos siuntimas į Directo (IN) === |
Duomenys siunčiami naudojant ''form/urlencoded'' POST metodą. | Duomenys siunčiami naudojant ''form/urlencoded'' POST metodą. | ||
Užpildomi formos kintamieji: | Užpildomi formos kintamieji: | ||
- | * **put**=1 | + | * ''put=1'' |
- | * **what**=INVOICE | + | * ''what=INVOICE'' |
- | * **key**=SUGENERUOTAS_RAKTAS | + | * ''key=SUGENERUOTAS_RAKTAS'' |
- | * **xmldata**=<?xml version="1.0" encoding="utf-8"?><PAYLOAD> | + | * ''xmldata=<?xml version="1.0" encoding="utf-8"?><PAYLOAD>'' |
- | Šis siuntimas naudojamas, pavyzdžiui, kai pardavimo sąskaita yra sugeneruojama išorinėje sistemoje, kurią reikia perduoti į „Directo“. | + | Įvesties sąsajoje XML turi būti išsiųstas adresu [[https://login.directo.ee/xmlcore/demo_ee/xmlcore.asp]] POST su kintamaisiais ''put = 1'', ''key = [appkey value]'', ''what = order'' (arba ''what = customer'' arba ''what = item'') ir ''xmldata = [XML turinys]'' XML įvestis turi atitikti schemą. |
<wrap important> | <wrap important> | ||
Linija 89: | Linija 87: | ||
</wrap> | </wrap> | ||
- | Tarkime, kad šiuo atveju URL pvz. https://login.directo.ee/xmlcore/this_is_the_worlds_greatest_company/xmlcore.asp | + | **Praktinis pavyzdys** |
- | Pavyzdinio serviso XSD schemą: [[http://wiki.directo.ee/_media/et/xml_in_arved.xsd|xml_in_arved.xsd]]. | + | Tokio tipo įvestis naudojama, pavyzdžiui, kai išorinėje sistemoje generuojami pardavimo užsakymai, kurie turi būti atspindėti Directo. Taip pat, pateikiamas pirkėjų schemos aprašymas. |
+ | |||
+ | Tarkime, kad šiuo atveju URL pvz. [[https://login.directo.ee/xmlcore/this_is_the_worlds_greatest_company/xmlcore.asp]] | ||
+ | |||
+ | Pavyzdinio serviso XSD schemą: [[http://wiki.directo.ee/_media/et/xml_in_arved.xsd]]. | ||
Pavyzdinis XML: | Pavyzdinis XML: | ||
Linija 144: | Linija 146: | ||
</wrap> | </wrap> | ||
- | ==== 2.4. HTML forma ==== | + | **Pirkėjo įvesties sąsaja:** |
+ | |||
+ | Duomenys aprašyti schemoje [[https://login.directo.ee/xmlcore/demo_ee/xml_IN_kliendid.xsd]] . Duomenų registravimas yra toks pat kaip užsakymų registravimas. XML, kuris atitinka schemą, bet nenaudoja visų galimų atributų, gali atrodyti taip: | ||
+ | |||
+ | <code xml> | ||
+ | <?xml version = "1.0" encoding = "utf-8" ?> | ||
+ | <customers > | ||
+ | <customer code = "Customer code1 " name = "Name" address1 = "address11" address2 = "address21" address3 = "address31" email = " email1 " regno = " regno1 " class = " class1 " type = " 1 " > | ||
+ | </ customer > | ||
+ | </ customers > | ||
+ | </code> | ||
+ | |||
+ | === 2.4. HTML forma === | ||
Parametrai, kuriuos reikia nurodyti: | Parametrai, kuriuos reikia nurodyti: | ||
Linija 173: | Linija 187: | ||
- | ==== 2.4. Pavyzdys PHP kalba ==== | + | === 2.5. Pavyzdys PHP kalba === |
Į servisą galima kreiptis bet kokia kalba, jeigu ta programavimo kalba yra galimybė padaryti https request‘ą, pateikiame pavyzdį PHP kalba: | Į servisą galima kreiptis bet kokia kalba, jeigu ta programavimo kalba yra galimybė padaryti https request‘ą, pateikiame pavyzdį PHP kalba: | ||
Linija 243: | Linija 257: | ||
</code> | </code> | ||
+ | |||
+ | === 2.6. Postman === | ||
+ | [[https://www.postman.com/|Postman]] aplinkos išvestį ir įvestį galima atsisiųsti [[https://wiki.directo.ee/_media/et/directo.demo.postman_collection.json|čia]], tada importuoti kaip kolekciją į Postman ir ten išbandyti. | ||
+ | |||
+ | ==== 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)| Document successfully updated (if document update feature is used)| | ||
+ | | 0 | Confirmed | (if auto document confirmation is used) |Dokumentas sėkmingai patvirtintas (jei naudojamas automatinis dokumentų patvirtinimas)|Document successfully confirmed (if auto document confirmation is used)| | ||
+ | | | | ||
+ | | 2 | Too secure location | | Informuokite Directo|Please inform Directo| | ||
+ | | 3 | Database is moved to a new server. Takes about 15 minutes | |Duomenų bazė perkelta į kitą serverį, prašome palaukti 15 minučių|Database has been transferred to another server, please wait 15 minutes| | ||
+ | | 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| Non-existent user| | ||
+ | | 7 | Invalid IP source given | | Neegzistuojantis arba apribotas darbuotojas|Non-existent or restricted user| | ||
+ | | 8 | Invalid xml given: ... | | Klaidingas ar neteisingos struktūros XML (skaityti pranešimo tekstą)|Invalid, incorrectly structured XML (please read the message | | ||
+ | | 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|Customer unique field has not been sent or set| | ||
+ | | 14 | Update not allowed | (if document is commited or has related documents) | Negalima atnaujinti dokumento (greičiausiai su dokumentu yra kitų susijusių dokumentų)|Unable to renew document (it is possible the document has been linked with other documents)| | ||
+ | | | | ||
+ | | 17 | Document insert failed | |Dokumentas nesukurtas, nes nerasta numeracija (nenurodyta, nenustatyta, pasibaigusi,...) |Document not created, this is because the numbering has not been found (not identified, not set up, expired...)| | ||
+ | | 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, yra susijusių dokumentų,...)| | ||
+ | | 29 | Not confirmed: ... | (if auto document confirmation is used) | Dokumentas nepatvirtintas, priežastis pateikta atsakyme| | ||
+ | | | | ||
+ | | 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: ... | |Informuokite Directo| |