OPAY / Techninė informacija / PHP biblioteka / Bibliotekos API

Bibliotekos API

Metodai, skirti pasirašymo būdui nustatyti siunčiant ir gaunant duomenis iš/į OPAY.

Visų pirma yra tikrinama ar nustatytas privatus raktas su sertifikatu, jei ne, tada tikrinama ar nustatytas pasirašymo slaptažodis. Todėl jei nustatysite ir tą, ir tą, bus naudojamas asimetrinis pasirašymas/parašo tikrinimas su privačiu raktu ir sertifikatu.

void setMerchantRsaPrivateKey(string $merchantRsaPrivateKey)

Metodas, skirtas prekybininko privačiam raktui nustatyti.  Naudojamas kartu su metodu setOpayCertificate.

void setOpayCertificate(string $opayCertificate)

Metodas, skirtas OPAY sertifikatui nustatyti. Naudojamas kartu su metodu setMerchantRsaPrivateKey.

void setSignaturePassword(string $signaturePassword)

Metodas, skirtas OPAY išduotam pasirašymo slaptažodžiui nustatyti. Naudojamas vietoje setMerchantRsaPrivateKey ir setOpayCertificate.

int getTypeOfSignatureIsUsed()

Metodas grąžina koks parašo algoritmas bus naudojamas siunčiant duomenis į OPAY.
Galimos  grąžinamos reikšmės: OpayGateway::SIGNATURE_TYPE_PASSWORD arba OpayGateway::SIGNATURE_TYPE_RSA

Metodai, naudojami siunčiant užklausą apmokėjimui.

array signArrayOfParameters(array $parametersArray)

Prie asociatyvaus parametrų masyvo $parametersArray metodas prideda dar vieną masyvo narį indekso pavadinimu "rsa_signature" arba "password_signature" (priklausomai nuo jūsų nustatyto pasirašymo būdo), kurio reikšmė yra šio masyvo struktūrą užtvirtinantis skaitmeninis parašas.

string generateAutoSubmitForm(string $url, array $parametersArray[, boolean $sendEncoded = true])

Metodas, skirtas HTML dokumentui, su jame esančia forma (<form>), sugeneruoti. Forma sudaryta iš parametrų, kuriuos ruošiamasi siųsti POST metodu į $url parametru pateiktą adresą. HTML dokumentas taip pat turi JavaScript fragmentą, kuris automatiškai patvirtitna (angl. submit) formą. Todėl išvedant šį HTML dokumentą  į naršyklę, įvyksta vartotojo nukreipimas į pateiktą adresą kartu su duomenimis, siunčiamais POST metodu.
  • $url - Pilnas HTTPS adresas kartu su nurodytu protokolu. Pvz.: https://gateway.opay.lt/pay/
  • $parametersArray - Masyvas parametrų, kurie bus siunčiami. Masyvo asociatyvus indeksas atspindi parametro pavadinimą, o reikšmė - parametro reikšmę.
  • $sendEncoded - Jei nurodyta reikšmė TRUE, tada visi parametrai bus suspausti ir siunčiami kaip vienas parametras pavadinimu "encoded".

string convertArrayOfParametersToEncodedString(code $parametersArray)

Metodas konvertuoja parametrų masyvą į užkoduotą eilutę. Kurią galima siųsti į OPAY kaip POST/GET parametrą pavadinimų "encoded". Jeigu naudojate funkciją generateAutoSubmitForm su parametro $sendEncoded reikšme TRUE, tai funkcijos convertArrayOfParametersToEncodedString papildomai naudoti nebereikia.

Metodai, naudojami priimant iš OPAY užklausą (pranešimą) apie apmokėjimą.

array convertEncodedStringToArrayOfParameters(string $encodedString)

Metodas konvertuoja užkoduotą eilutę (kuri ateina parametru "encoded") į parametrų masyvą.

boolean verifySignature(array $parametersArray)

Funkcija patikrina ar pasirašyto $parametersArray masyvo informacija yra autentiška ir ar panaudotas teisingas raktas tai informacijai pasirašyti. $parametersArray masyvas laikomas pasirašytu kai turi narį indekso pavadinimu "rsa_signature" arba "password_signature".

Metodai, naudojamis komunikacijai su OPAY web servisais

array webServiceRequest(string $url, array $parametersArray[, boolean $sendEncoded = true])

Metodas skirtas komunikuosi su OPAY web servisais ir grąžinti web servisų atsakymus
  • $url - Pilnas HTTPS adresas kartu su nurodytu protokolu. Pvz.: https://gateway.opay.lt/pay/
  • $parametersArray - Masyvas parametrų, kurie bus siunčiami. Masyvo asociatyvus indeksas atspindi parametro pavadinimą, o reikšmė - parametro reikšmę.
  • $sendEncoded - Jei nurodyta reikšmė TRUE, tada visi parametrai bus suspausti ir siunčiami kaip vienas parametras pavadinimu "encoded".