Account-Login-v1

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

Bejelentkezés

GET /Account/Login

Az alábbi hívással bejelentkeztethetünk egy felhasználót a Barion rendszerbe. Sikeres bejelentkezés esetén a hívó megkapja a bejelentkeztetett felhasználó főbb adatait.

A Barion mobilalkalmazás ezt az API hívást használja egy felhasználó Barionba történő bejelentkeztetésére, majd a kapott válaszban található adatokból építi fel a grafikus felületen a felhasználó "névjegyét" és jelzi ki aktuális egyenlegét.

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

Kimenet

A kimenet minden hívás esetén hasonló felépítésű. Amennyiben sikeres hívás történt az ErrorList hibatömb üresen érkezik. Ha hiba történt, akkor a hibatömbben láthatóak ezek a hibák, de ilyen esetben is megkapjuk a többi kimeneti paramétert, csak üresen vagy pedig egy default alapértékkel.

Mező Típus Leírás Formátum / Példa
LoginName string Felhasználónév. Jelen pillanatban ez azonos az e-mail címmel. pistike@example.com
EmailAddress string A felhasználó e-mail címe. pistike@example.com
FirstName string A felhasználó keresztneve, amennyiben ki van töltve. Ha nincs kitöltve, értéke null. Pistike
LastName string A felhasználó vezetékneve, amennyiben ki van töltve. Ha nincs kitöltve, értéke null. Kovács
OrganizationName string Céges felhasználó esetén a cég neve. Kovács és Társa Kft.
Balance integer A felhasználó egyenlege. 25000
ServerTime string A pillanatnyi szerveridő UTC időzónában, de Z nélkül a végén. 2014-12-06T12:34:56.182
MajorId integer A felhasználóhoz tartozó iBeacon Bluetooth ID major száma. Ez az információ a közelségi fizetés bonyolításakor használatos. 1
MinorId integer A felhasználóhoz tartozó iBeacon Bluetooth ID minor száma. Ez az információ a közelségi fizetés bonyolításakor használatos. 101
TopUpCode string A felhasználó Barion feltöltőkódja hármas tagolással. 123 456 789
ReferralCode string A felhasználó azonosító száma, amelyet a meghíváshoz használhat. 123456789
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.

Példák

Sikeres bejelentkezés

Az alábbi példában egy sikeres bejelentkezés látható. A kimenetben a hívó megkapja a bejelentkeztetett felhasználó adatait.

Bemenet

https://api.barion.com/Account/Login?UserName=pistike@example.com&Password=SzepHosszuJelszo

Kimenet

{
    "LoginName": "pistike@example.com",
    "EmailAddress": "pistike@example.com",
    "FirstName": "Pistike",
    "LastName": "Kovacs",
    "OrganizationName": "",
    "Balance": 15000,
    "ServerTime": "2013-10-21T08:35:46",
    "MinorId": 12345,
    "MajorId": 0,
    "TopUpCode": "123 456 789",
    "ReferralCode": "123456789",
    "ErrorList": []c
}

Sikertelen bejelentkezés

Hibás jelszó

Az alábbi példában sikertelen bejelentkezési hívás látható. Ez esetben a felhasználóhoz egy rossz jelszót adtunk meg.

Bemenet

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

Kimenet

{
    "LoginName": null,
    "EmailAddress": null,
    "FirstName": null,
    "LastName": null,
    "OrganizationName": null,
    "Balance": 0,
    "ServerTime": "2014-12-06T08:35:46",
    "MinorId": null,
    "MajorId": null,
    "TopUpCode": null,
    "ReferralCode": null,
    "ErrorList": [
        {
            "ErrorNumber": 1,
            "ErrorMessage": "A felhasználói név vagy jelszó nem megfelelő!",
            "Details": null
        }
    ]
}

Hiányzó paraméterek

Az alábbi példában nem küldtünk be egyetlen paramétert sem. A rendszer minden hiányzó mező után egy külön hibát jelez. A Barion ez esetben is megpróbálja beléptetni a felhasználót, de mivel mind a felhasználónév, mind a jelszó értéke null, a bejelentkezés sikertelen.

Bemenet

https://api.barion.com/Account/Login

Kimenet

{
    "LoginName": null,
    "EmailAddress": null,
    "FirstName": null,
    "LastName": null,
    "OrganizationName": null,
    "Balance": 0,
    "ServerTime": "2014-12-06T08:35:46",
    "MinorId": null,
    "MajorId": null,
    "TopUpCode": null,
    "ReferralCode": null,
    "ErrorList": [
        {
            "ErrorNumber": 2001,
            "ErrorMessage": "Validation Error: UserName Value: The UserName field is required.",
            "Details": null
        },
        {
            "ErrorNumber": 2001,
            "ErrorMessage": "Validation Error: Password Value: The Password field is required.",
            "Details": null
        },
        {
            "ErrorNumber": 1,
            "ErrorMessage": "A felhasználói név vagy jelszó nem megfelelő!",
            "Details": null
        }
    ]
}