EDIT_I64

Aprašymas

Lojalumo taškų koregavimas

Specifikacija

Address

POST https://api.manorivile.lt/client/v2

Header

ApiKey : Privalomas. Unikalus API raktas išduodamas užsakant paslaugą
Content-Type : Privalomas. Kokiu formatu paduodami parametrai ir duomenys (request):
- application/xml
- application/json
Accept: Neprivalomas. Gražinamo rezultato (response) formatas
- application/xml(default)
- application/json (veikia nuo Manorivile-Gateway-1.1.0 versijos)

Body

method : EDIT_I64
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo išmetimas
data: perduodami duomenys:
- I64 - atitinkamos lentelės laukai (i64)

Vienu metu veiksmai atliekami tik su vienu įrašu.

Pirmi 7 ApiKey simboliai (pvz USERABC.JQKPG1d7Pkjxj37ObsgdfEkvfEfvF1oL7h7UMOLo -> USERABC) yra vartotojo vardas Rivile GAMA programoje, kuriuo bus kuriami ar koreguojami įrašai.

pvz application/xml:

<body>
    <method>EDIT_I64</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <I64>
            <I64_KODAS_DL>010000000001</I64_KODAS_DL>
            <I64_TASKAI>100</I64_TASKAI>
            <I64_KODAS_IS>01</I64_KODAS_IS>
            <I64_TIPAS>1</I64_TIPAS>
        </I64>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_I64",
    "params": {
        "oper": "I"
    },
    "data": {
        "I64": {
            "I64_KODAS_DL": "010000000001",
            "I64_TASKAI":100,
            "I64_KODAS_IS": "01",
            "I64_TIPAS": 1
        }
    }
}

Response (status 200 OK)

Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>.

pvz:

<?xml version='1.0'?>
<RET_DOK>
    <I64>
        <I64_KODAS_DR>01R000000001</I64_KODAS_DR>
        <I64_EIL_NR>1</I64_EIL_NR>
        <I64_KODAS_DL>010000000001</I64_KODAS_DL>
        <I64_TASKAI>100</I64_TASKAI>
        ...
    </I64>
</RET_DOK>

Response (status 400)

Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id>14433105830.9def1bf4.1584217427751</id>
    <durationMs>45</durationMs>
    <errorMessage>nepavyko įvykdyti metodo</errorMessage>
    <errors>
        <error>
            <data>&lt;I64>&lt;/I64></data>
            <dataErrors>
                <dataError>
                    <tag>I64_OP_DATE</tag>
                    <code>16004</code>
                    <message>Neprieinamas periodas</message>
                </dataError>
            </dataErrors>
        </error>
    </errors>
</RET_DOK>

Response (status 401)

Blogai nurodytas adresas / neteisingai nurodytas API raktas / nenurodytas API raktas / pasibaigęs API rakto galiojimas, pvz

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Api key is not valid</errorMessage>
</RET_DOK>

Response (status 502)

Nepaleistas MANO Rivile Gateway arba kitaip sutrikusi jo veikla

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>Rivile GAMA database is unavailable. Please check if the gateway is running and is set up correctly.</errorMessage>
</RET_DOK>

Response (status 504)

Laiku nebuvo gautas Rivile API užklausos atsakymas, pavyzdžiui, apkrauta GAMA duomenų bazė

<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
    <id/>
    <durationMs>0</durationMs>
    <errorMessage>No response received from client gateway</errorMessage>
</RET_DOK>

Response (status 500)

Bendrinė sistemos klaida, pvz

<?xml version='1.0' encoding='UTF-8'?>
<Map>
    <timestamp>2020-02-05T12:34:26.890+0000</timestamp>
    <status>500</status>
    <error>Internal Server Error</error>
    <message>No message available</message>
    <path>/v2</path>
</Map>

Koregavimas ir išmetimas

Koregavimas, išmetimas vyksta pagal lentelės raktą (Primary Key)

Koreguojant informaciją bus koreguojami tik perduodami laukai.

pvz koregavimas:

<body>
    <method>EDIT_I64</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <I64>
            <I64_KODAS_DR>01R000000001</I64_KODAS_DR>
            <I64_EIL_NR>1</I64_EIL_NR>
            <I64_OP_DATE>2020-03-13</I64_OP_DATE>
        </I64> 
    </data>
</body>

pvz išmetimas:

<body>
    <method>EDIT_I64</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <I64>
            <I64_KODAS_DR>01R000000001</I64_KODAS_DR>
            <I64_EIL_NR>1</I64_EIL_NR>
        </I64>  
    </data>
</body>

PHP pvz

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $url);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
      'ApiKey: uUCz6UD.sKVrjaWRDJAH1c7l4qL2nOoN2K0jARkvuHDdYsss',
      'Content-Type: application/json',
      ]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
$response = curl_exec($ch);
curl_close($ch);

Lentelės

I64

Lojalumo taškų lentelė

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
I64_KODAS_DR	C(12)	Operacijos Nr.	Privalomas (kaip oper=D,U)
I64_EIL_NR	N(6)	Eilutės numeris(unikalumui)	Privalomas (kaip oper=D,U)
I64_KODAS_DL	C(12)	Lojalumo kortelė	Privalomas
I64_KODAS_WW	C(12)	POS operacijos Nr.
I64_OP_DATE	T(8)	Operacijos data	Privalomas
I64_PAV	C(40)	Aprašymas
I64_TASKAI	N(14)	Taškai
I64_TIPAS	N(1)	Tipas: 1-taškai,2-apmokėjimas,3-prekė, 4-, 5-	Privalomas
I64_KODAS_PS	C(12)	Prekė/Sąskaita	Privalomas
I64_SUMA	N(12,2)	Suma
I64_ADDUSR	C(12)	Įrašo autorius	Neperduodamas. Pildomas automatiškai (oper=`I`), ApiKey - pirmi 7 simboliai
I64_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
I64_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
I64_KODAS_US	C(12)	Matavimo vienetas	Privalomas
I64_KODAS_IS	C(12)	Padalinys	Privalomas
I64_REZERVAS1	C(12)	Rezervas1
I64_REZERVAS2	C(12)	Rezervas 2
I64_REZERVAS3	C(60)	Rezervas 3
I64_KODAS_DL_A	C(12)	Alternatyvus lojalumo kodas
I64_ID_PAR	C(12)	Parduotuvės Id.
I64_ID_POS	C(12)	POS id.
I64_KORTELES_ID	C(40)	Kortelės Nr.