Ugrás a tartalomra

Fejlesztés3 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

parameteralapkiterjesztett
email✅✅
threshold✅✅
phoneNumber❌✅
countryCode❌✅
postalCode❌✅
addressLine❌✅
orderId❌❌

Visszajelzések

parameteralapkiterjesztett
email✅✅
outcome✅✅
orderId✅✅
phoneNumber❌✅
countryCode❌✅
postalCode❌✅
addressLine❌✅

Javasolt fordítások az API által adott reason értékhez

angolmagyar
Test hash was used.Teszt e-mail cím.
Run out of request quota for current billing period, upgrade your subscription to resolve!Csomag kimerült!
Active exception found for this hash in your account.A fiókodban szereplő Kivétel.
Temporary e-mail was used.Eldobható e-mail cím.
Mailbox does not exist.E-mail fiók nem létezik.
No Signals were found.Nem találtunk adatot.
Total 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.
User opted out of the processing of their personal data.Az érintett tiltakozott személyes adatainak kezelése ellen.
Signals found, checks passed.Ellenőrzés sikeres, rendben.

A javasolt fordítások megtalálhatók az utanvet-ellenor/client-php Reasons.php fájljában.

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"?)

A javasolt fordítások megtalálhatók az utanvet-ellenor/client-php Reasons.php fájljában.

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ő szállítá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 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 állapot vá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.

Kapcsolódó olvasnivaló

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?