Account-UserDetails-v1

A Barion wikiből
  • Tervezet
  • Üzlet
  • Informatika
  • Pénzügy
  • Jog
  • 99%
  • Online elfogadó
  • Mobil elfogadó
  • Pénztárgép
  • Feltöltés
  • Piactér
  • Nonprofit
  • Parkolas

Felhasználó adatainak lekérése

GET /Account/UserDetails

Az alábbi hívással kérdezhetők le egy adott felhasználó publikus adatai. Az adatok lekéréséhez be kell küldeni az azonosításhoz szükséges felhasználónevet és jelszót, valamint annak a felhasználónak az e-mail címét, akinek az adatait le szeretnénk kérdezni.

A Barion alkalmazás ezt az API hívást használja péládul pénzküldés esetén arra, hogy e-mail címmel megadott címzett esetén kijelezze a felhasználó nevét a küldő félnek - már amennyiben az ki van töltve.

Bemenet

Mező neve Mező típusa Kötelező Megkötések Alapértelmezett érték Leírás Formátum / Példa
UserName string Kötelező min. 6, max. 254 karakter nincs Az API hívás hívójának Barion azonosító e-mail címe. user@example.com
Password string Kötelező min. 8, max. 100 karakter nincs Az API hívás hívójának jelszava. EgySimaJelszo
LoginName string Kötelező min. 6, max. 254 karakter nincs Annak a felhasználónak a bejelentkezési neve, akinek le szeretnénk kérdezni az adatait. Jelen pillanatban ez a felhasználó email címe. pistike@example.com

Kimenet

A kimenet felépítése megegyezik a UserDetails objektum struktúrájával, kiegészítve a hívás során esetlegesen felmerült hibák listájával.

Mező Típus Leírás Formátum / Példa
LoginName string A felhasználó bejelentkezési neve. Jelen pillanatban azonos az e-mail címmel. pistike@example.com
EmailAddress string A felhasználó email címe pistike@example.com
FirstName string A felhasználó keresztneve, amennyiben ki van töltve. Cég esetén a kapcsolattartó keresztneve. Pistike
LastName string A felhasználó vezetékneve, amennyiben ki van töltve. Cég esetén a kapcsolattartó vezetékneve. Kovács
OrganizationName string Céges felhasználó esetén a cég neve. Kovács és Társa Kft.
EmailAddresses string[] A felhasználóhoz tartozó további e-mail címek (ha van neki).
["pistike@example.com", "pistike2@example.com"]
PhoneNumbers string[] A felhasználóhoz tartozó telefonszámok (ha van neki). Cég esetén a kapcsolattartó telefonszáma.
["36301234567", "36308889999"]
ErrorList Errorlist A kérés során esetlegesen felmerülő hibákat tartalmazó tömb. Sikeres hívás esetén ez a tömb üres. Errorlist

Hibakódok

Hiba kódja Hiba leírása
1 Nem megfelelő felhasználónév vagy jelszó.
999 Ismeretlen hiba történt a kérés feldolgozása során.
2001 A bemeneti paraméterek valamelyike nem felelt meg az előírásoknak. Ez a hiba annyiszor szerepel(het) a kimenetben, ahány mező hibás volt. Ez esetben az ErrorMessage mezőben található a konkrét hiba: a Validation Error után látható a hibás mező megnevezése, a Value pedig a hiba leírását tartalmazza.
4004 A keresett felhasználó nem található.

Példák

Sikeres adatlekérés

Magánszemély felhasználó

Az alábbi példában a felhasználó sikeresen lekérdezi saját adatait.

Bemenet

https://api.barion.com/Account/UserDetails?UserName=pistike@example.com&Password=EgySimaJelszo&LoginName=pistike@example.com

Kimenet

{
    "LoginName": "pistike@example.com",
    "EmailAddress": "pistike@example.com",
    "FirstName": "Pistike",
    "LastName": "Kovacs",
    "OrganizationName": null,
    "EmailAddresses": [
        {
            "EmailAddress": "pistike@example.com",
            "EmailAddress": "pistike2@example.com"
        }
    ],
    "PhoneNumbers": [
        {
            "PhoneNumber": "06201234567",
            "PhoneNumber": "06301234567"
        } 
    ],
    "ErrorList": []
}

Céges felhasználó

Az alábbi példában a felhasználó sikeresen lekérdezi egy webshop tulajdonosának adatait.

Bemenet

https://api.barion.com/Account/UserDetails?UserName=pistike@example.com&Password=EgySimaJelszo&LoginName=bolt@example.com

Kimenet

{
    "LoginName": "bolt@example.com",
    "EmailAddress": "bolt@example.com",
    "FirstName": null,
    "LastName": null,
    "OrganizationName": "Online Bolt 2014 Kft.",
    "EmailAddresses": [
        {
            "EmailAddress": "bolt@example.com",
            "EmailAddress": "bolt2@example.com",
            "EmailAddress": "bolt3@example.com"
        }
    ],
    "PhoneNumbers": null,
    "ErrorList": []
}

Sikertelen adatlekérés

Nem létező felhasználó

Az alábbi példában rosszul adtuk meg a lekérdezni kívánt felhasználó bejelentkezési nevét, így a rendszer nem találja.

Bemenet

https://api.barion.com/Account/UserDetails?UserName=pistike@example.com&Password=EgySimaJelszo&LoginName=nemletezik@example.com

Kimenet

{
  "LoginName": null,
  "EmailAddress": null,
  "FirstName": null,
  "LastName": null,
  "OrganizationName": null,
  "EmailAddresses": null,
  "PhoneNumbers": null,
  "ErrorList": [
    {
      "ErrorNumber": 4004,
      "ErrorMessage": "A felhasználó nem található.",
      "Details": null
    }
  ]
}

Hibás bejelentkezési adatok

Az alábbi példában sikertelen az adatlekérés, mert a hívó fél rosszul azonosította magát.

Bemenet

https://api.barion.com/Account/UserDetails?UserName=moricka@example.com&Password=MasikJelszo&LoginName=pistike@example.com


Kimenet

{
  "LoginName": null,
  "EmailAddress": null,
  "FirstName": null,
  "LastName": null,
  "OrganizationName": null,
  "EmailAddresses": null,
  "PhoneNumbers": null,
  "ErrorList": [
    {
      "ErrorNumber": 1,
      "ErrorMessage": "A felhasználói név vagy jelszó nem megfelelő!",
      "Details": null
    }
  ]
}