RegisterDevice-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

Készülék regisztrálása

SIGNALR RegisterDevice

Ahhoz, hogy egy klienst használhassunk arra, hogy azonnali üzeneteket kapjon a Barion rendszeréből, be kell regisztrálnunk a Barion HUB-ba. Ehhez először ki kell építenünk egy SignalR kapcsolatot. Ennek a kapcsolatnak a tulajdonságait és a kliensnek tulajdonságait kell aztán a szerver oldali RegisterDevice metódus meghívásával regisztrálni a Barionba.

A Barion mobil applikációk ezt a metódust használják arra, hogy tudassák a Barion rendszerrel, hogy ők kapcsolódtak.

Figyelem: minden kliensnek be kell regisztrálnia magát ezen a híváson keresztül, különben nem fog üzeneteket kapni.

Bemeneti paraméterek

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
DeviceId string Kötelező nincs nincs A kliens egyedi azonosítója. Ez alapján különböztethető meg a kliens a kommunikáció során. Mobiltelefon esetén a különböző gyártók esetén az alábbi azonosítókat ajánlott használni:
  • Apple: [identifierForVendor]
  • Android: [Secure.ANDROID_ID]
45fe9970af1943c9
DeviceType DeviceType Opcionális DeviceType 0 A kliens "típusa", milyen fajta kliensről van szó 10
DeviceVendor DeviceVendor Opcionális DeviceVendor 0 Mobiltelefonok esetén használt mező, a telefon operációs rendszerének típusa. 10
DeviceInfo string Opcionális JSON formátum nincs A kliensről bármilyen olyan hasznos információ, amiről az integráló úgy gondolja, hogy az esetleges későbbi hibakeresés szempontjából fontos lehet. (Például kliens oldali szoftver verziószáma, kliens fizikai tulajdonságai, stb.) Bármilyen
{
    ClientVersion: "1.7.8"
}
CanReceivePushNotification boolean Opcionális nincs false Azt jelzi, hogy a kliens fizikailag képes Push Notification-ök fogadására. (Jellemzően mobil kliensek esetén) true
SubscribeToPushNotifications boolean Opcionális nincs false Azt jelzi, hogy a kliens szeretne Push Notification-öket kapni. (Jellemzően mobil kliensek esetén) Jelenleg a rendszer ezt figyelmen kívül hagyja, mindenképp true értéket állít be. true
PushNotificationId string Opcionális max. 250 karakter nincs Amennyiben képes a mobil kliens Push Notification-t fogadni és szeretne is, akkor itt kell megadni az azonosítót, amit a Google vagy Apple szerverektől kapott a kliens. 8565a5b710436f82d2fff15ea0dacfe8c0af4fd72ff83b4eb2bc953a54419070
ShopGuid string Opcionális GUID formátum nincs A készülékhez tartozó bolt azonosítója; ha meg van adva, akkor ellenőrzésre kerül, hogy a bolt valóban a felhasználóhoz tartozik-e. 300c8f8c-7dea-4a61-86bc-83d7b600e617

Visszatérési értékek

Mező Típus Leírás Formátum / Példa
DeviceRegistered boolean Igaz értéket vesz fel, ha a klienst sikeresen regisztráltuk a Barionba. true
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

Példák

Az alábbi példában javascriptből iratkozunk fel. Ebben a példában nincs benne a SignalR kapcsolódás, azt a SignalR kapcsolódás leírásánál láthatjuk.

Figyeljünk arra, hogy szerver oldali hívást csak azután indíthatunk, hogy a SignalR kapcsolatot felépítettük!

var clientRegistrationData = {
    UserName: "szabobalint@gmail.com",
    Password: "EgySimaJelszo",
    DeviceId: "1234ABCD6789DEF0",  
    DeviceType: 30,
    DeviceVendor: 0,
    CanReceivePushNotification: false,
    SubscribeToPushNotification: false
};
 
myConnection.start().done(function () {
    barionHubProxy.invoke( 'registerDevice', clientRegistrationData).done(function(response){
	console.log(response);
    });
});

A fenti példában a response váltózóban a következő adatokat kapjuk, ami azt jelenti, hogy sikeres volt a kliens regisztrációja:

{
	"DeviceRegistered": true,
	"ErrorList": []
}