Ugrás a tartalomra

Fejlesztés4 perc olvasás

API dokumentáció

A v2-es API dokumentációja és a hozzá tartozó Postman collection megtalálható ezen a linken.

Adatcsomag paramétereinek részletei:

paraméterkérés típusaleírás
emailLekérés + VisszajelzésA vásárló e-mail címe
thresholdLekérés-1 és +1 közötti szám, az ellenőrzés szigorúságát határozza meg.
Részletek itt.
outcomeVisszajelzés+1: sikeres
-1: nem vette át
orderIdLekérés (opcionális) + VisszajelzésA rendelés nyilvános azonosítója.
- példa: #UV-12345
countryCodeLekérés (opcionális) + Visszajelzés (opcionális)Országkód ISO 3166-1 alpha-2 formátumban.
- példa: HU
phoneNumberLekérés (opcionális) + Visszajelzés (opcionális)Telefonszám az E.164 nemzetközi formátumban, + jellel kezdve.
- példa: +36209238883
postalCodeLekérés (opcionális) + Visszajelzés (opcionális)Irányítószám az adott szállítási ország szokásainak megfelelően írva.
- példa: 8640
addressLineLekérés (opcionális) + Visszajelzés (opcionális)Címsor, az ország, országkód, irányítószám nélkül. Több sor esetén egy sorba összefűzve.
- példa: Szigligeti utca 10.

Kötelező paraméterek

Lekérések

paraméteralapkiterjesztett
email✅✅
threshold✅✅
phoneNumber❌✅
countryCode❌✅
postalCode❌✅
addressLine❌✅
orderId❌❌

Visszajelzések

paraméteralapkiterjesztett
email✅✅
outcome✅✅
orderId✅✅
phoneNumber❌✅
countryCode❌✅
postalCode❌✅
addressLine❌✅

Válaszkódok és javasolt fordítások

A reasonCode az eredmény okának azonosítója, a reason az angol szöveges leírása. Az ok programozott felismeréséhez és a fordítás kiválasztásához a reasonCode értékét használd.

A status oszlop a JSON-válasz status mezőjét jelöli. A feldolgozott kérések HTTP-státusza ettől függetlenül 200.

reasonCodereason (angol)Javasolt magyar szövegstatus
TEST_HASHTest hash was used.Teszt e-mail cím.200
OUT_OF_QUOTARun out of request quota for current billing period, upgrade your subscription to resolve!Csomag kimerült.402
EXCEPTION_FOUNDActive exception found for this hash in your account.A fiókodban szereplő Kivétel.200
TEMP_EMAILTemporary e-mail was used.Eldobható e-mail cím.204
MAILBOX_NON_EXISTENTMailbox does not exist.E-mail fiók nem létezik.204
NOT_FOUNDNo Signals were found.Nem találtunk adatot.404
THRESHOLD_NOT_METTotal rate did not meet the minimum threshold set.A vásárló reputációja nem érte el a beállított küszöbértéket.200
OPTED_OUTUser opted out of the processing of their personal data.Az érintett tiltakozott személyes adatainak kezelése ellen.451
PASSEDSignals found, checks passed.Ellenőrzés sikeres, rendben.200

A PHP-kliensben kilenc nyelven érhetők el a javasolt szövegek:

  • angol (en),
  • magyar (hu),
  • román (ro),
  • bolgár (bg),
  • szlovák (sk),
  • cseh (cs),
  • horvát (hr),
  • szerb (sr) és
  • lengyel (pl).

A szövegeket a Reasons.php fájl tartalmazza.

A fordítást a Reasons::getLabel() metódussal kérheted le. Add meg a válasz reasonCode értékét és a kívánt nyelv kódját:

use UtanvetEllenor\Reasons;

$label = Reasons::getLabel($response->result->reasonCode, 'hu');

Ha a kért nyelvhez nincs fordítás, a metódus az angol szöveget adja vissza. Ismeretlen reasonCode esetén magát a kódot kapod vissza.

Eredmények felhasználása

Az utánvét elrejtéséhez/a vásárló szűréséhez a válasz blocked adattagjának értékét javasolt használni.

Eredmények megjelenítése

Ha ezeket az értékeket valamilyen felhasználói felületen (pl. admin felületen) meg szeretnéd jeleníteni, használd a reputation és/vagy good és bad értékek számszerű értékét. Próbáld elkerülni, hogy valamilyen leírással elfedd ezeket az értékeket, mert az félrevezetheti a felhasználókat.

Példák az API válaszok felhasználói felületen való megjelenítésére
Jó:
  • 3 sikeres, 2 sikertelen (kézbesítés), reputáció: 0.2
  • Sikeres kézbesítés: 60%
  • A válasz reason fordításának megjelenítése (pl.: A vásárló reputációja nem érte el a beállított küszöbértéket.)
Rossz:
  • A rendelés teljesítése nem javasolt (Miért? Nincs egyértelmű indoklás.)
  • Túl sok át nem vett rendelés. (Mi számít túl soknak?)
  • Rossz megbízhatósági mutató. (Mi számít "rossznak"?)

GY.I.K.

Mikor ellenőrizzük a vásárló megbízhatóságát?

Azt javasoljuk, hogy a checkout során, a háttérben.

Egyoldalas checkout esetén AJAX hívással frissítsd az elérhető fizetési módokat.

Többoldalas checkout esetén a vásárló adatait kérd be hamarabb, mint hogy az elérhető fizetési módokat megjelenítenéd neki.

Mit tegyünk, ha a vásárló elbukja az ellenőrzést?

Rejtsd el az utánvétet a fizetési módok közül.

Mikor küldjünk Visszajelzést az Utánvét Ellenőrnek?

A rendelés állapotváltozásakor a legjobb ezeket az adatokat beküldeni.

Mi történik, ha több Visszajelzést küldünk ugyanahhoz a rendeléshez?

A backendünk ellenőrzi, hogy van-e már beküldve Visszajelzés az adott rendeléshez: ha igen, azt fogja frissíteni egy újabb létrehozása helyett.

Integrációt segítő könyvtár (PHP) Sandbox rendszer Teszt e-mail címek

Elakadtál ennél a lépésnél?