EDIT_N64

Aprašymas

Lojalumo kortelės 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_N64
params :
- oper :
  - I - naujo įrašo sukūrimas
  - U - įrašo koregavimas
  - D - įrašo ištrynimas
data: perduodami duomenys:
- N64 - atitinkamos lentelės laukai (N64)

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_N64</method>
    <params>
        <oper>I</oper>
    </params>
    <data>
        <N64>
            <N64_KODAS_DL>010000000001</N64_KODAS_DL>
        </N64>
    </data>
</body>

pvz application/json:

{
    "method": "EDIT_N64",
    "params": {
        "oper": "I"
    },
    "data": {
          "N64": {
              "N64_KODAS_DL": "010000000001"
          }
    }
}

Response (status 200 OK)

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

pvz:

<?xml version="1.0" encoding="UTF-8" ?>
<RET_DOK>
    <N64>
         <N64_KODAS_DL>010000000001</N64_KODAS_DL>
         ...
     </N64>
</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;N64>&lt;/N64></data>
            <dataErrors>
                <dataError>
                    <tag>N64_KODAS_DL</tag>
                    <code>6010</code>
                    <message>Egzistuoja toks kodas</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_N64</method>
    <params>
        <oper>U</oper>
    </params>
    <data>
        <N64>
             <N64_KODAS_DL>010000000001</N64_KODAS_DL>
             <N64_PAV>PAV</N64_PAV>
         </N64>
    </data>
</body>

pvz išmetimas:

Išmesti galima kortelė kuri neturi taškų

<body>
    <method>EDIT_N64</method>
    <params>
        <oper>D</oper>
    </params>
    <data>
        <N64>
             <N64_KODAS_DL>010000000001</N64_KODAS_DL>
         </N64>
    </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

N64

Lojalumo kortelės lentelė

Laukas	Tipas	Aprašymas	Pastabos naudojant EDIT metodus
N64_KODAS_DL	C(12)	Kodas	Privalomas
N64_DATE	T(8)	Data
N64_KODAS_KS	C(12)	Klientas
N64_PAV	C(50)	Pavardė
N64_VARDAS	C(50)	Vardas
N64_KODAS_VS	C(12)	Vietovė
N64_ADR1	C(40)	Adresas1
N64_ADR2	C(40)	Adresas2
N64_ADR3	C(40)	Adresas3
N64_GIM_DATA	T(8)	Gimimo data
N64_LYTIS	N(1)	Lytis:1-vyras,2-moteris
N64_KODAS_LS_1	C(12)	Logistika 1
N64_KODAS_LS_2	C(12)	Logistika 2
N64_KODAS_LS_3	C(12)	Logistika 3
N64_KODAS_LS_4	C(12)	Logistika 4
N64_POZ_DATE	N(1)	Terminuota
N64_BEG_DATE	T(8)	Pradžios data
N64_END_DATE	T(8)	Pabaigos data
N64_USERIS	C(12)	Kas koregavo	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N64_R_DATE	T(8)	Kada koregavo	Neperduodamas. Pildomas automatiškai, Current Datetime
N64_ADDUSR	C(12)	Kas sukūrė	Neperduodamas. Pildomas automatiškai, ApiKey - pirmi 7 simboliai
N64_ASM_KODAS	C(20)	Asmens kodas
N64_TEL	C(30)	Telefono Nr.
N64_MOB_TEL	C(30)	Mobilus telefonas
N64_E_MAIL	C(60)	E-mail
N64_KORTELES_ID	C(40)	Kortelės ID
N64_BLOK_POZ	N(1)	Blokavimo požymis: 0-Ne,1-Taip
N64_BLOK_DATE	T(8)	Blokavimo data
N64_BLOK_USER	C(12)	Blokavimo vartotojas
N64_KODAS_LS_5	C(12)	Logistikos kodas 5
N64_KODAS_LS_6	C(12)	Logistikos kodas 6
N64_KODAS_LS_7	C(12)	Logistikos kodas 7
N64_KODAS_LS_8	C(12)	Logistikos kodas 8
N64_KORTELES_ID_A	C(40)	Pagrindinės kortelės nr.
N64_KODAS_SM	C(12)	Asmens kodas
N64_NEAKTYVI	N(1)	Neaktyvi- 0-aktyi,1-Neaktyvi
N64_KORTELES_ID_POZ	N(1)	Kortelių intervalo požymis
N64_KORTELES_ID_I1	C(40)	Kortelių intervalo pradžia
N64_KORTELES_ID_I2	C(40)	Kortelių intervalo pabaiga
N64_APRAS	C(40)	Aprasymas