Metodas skirtas sukurti reikiamą infrastrutūrą pokyčių registravimui norint dirbti tik su koreguotos informacijos nuskaitymu.
POST https://api.manorivile.lt/client/v2
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)method
: INIT_TRIGGER
Metodas paleidžiamas tik vieną kartą prieš pradedant dirbti su pokyčių metodais (pakartotinis paleidimas sistemai įtakos nedaro)
Metodas duomenų bazėje sukuria papildomas lenteles sisteminių lentelių pokyčiams registruoti:
Pokyčių lentelės talpina sisteminės lentelės raktinius stulpelius ir stulpelį nurodantį paskutinio pokyčio datą.
Pokyčių lenteles galima panaudoti rašant filtravimo sąlygas standartiniams metodams (žr. pavyzdį žemiau)
pvz application/xml
:
<body>
<method>INIT_TRIGGER</method>
</body>
pvz application/json
:
{
"method": "INIT_TRIGGER"
}
Grąžinama informacija XML formate tarp tag'ų <RET_DOK>..</RET_DOK>
.
pvz:
<?xml version='1.0' encoding='UTF-8' ?>
<RET_DOK>
<id>11395037911.a1526bff.1643288873804</id>
<durationMs>95</durationMs>
<columnNames>
<columnName>kodas_ps</columnName>
<columnName>r_date</columnName>
</columnNames>
<columnTypes>
<columnType>CHAR</columnType>
<columnType>TIMESTAMP</columnType>
</columnTypes>
<columnValues/>
</RET_DOK>
Nurodomas papildomas filtravimas pagal koregavimo laiką:
<body>
<method>GET_N17_LIST</method>
<params>
<listType>A</listType>
<fil>n17_kodas_ps in (select kodas_psfrom dbo.RGI_PS_Trigger_tablewhere r_date>='2022-01-04T16:30:00.000')</fil>
</params>
</body>
Klaida paduodant duomenis / SQL sintaksės klaidos / kitos DB klaidos
<?xml version='1.0' encoding='UTF-8'?>
<RET_DOK>
<id>0</id>
<durationMs>0</durationMs>
<errorMessage>Method INIT_TRIGGERG does not exist</errorMessage>
</RET_DOK>
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>
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>/v1</path>
</Map>
<?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, '{
"method": "INIT_TRIGGER"
}');
$response = curl_exec($ch);
curl_close($ch);