XPressEntry SDK-dokumentation

SDK Client Download: XPressEntrySDKClient #

Översikt #

XPressEntry SDK används för att hantera XPressEntry från en 3rd-partiprogram.
Alla datahanterare eller externa källor som XPressEntry integrerar med kommer att vara minst Read-Only via XPressEntry SDK.
Vissa datahanterare stöder XPressEntry som "Master" och tillåter ändringar från SDK till dessa system.

Mål: Tillåt 3rd-parter att få tillgång till XPressEntry-data och ändras i realtid.
Sekundärt mål: Tillåt 3rd-parter att lägga till / ta bort data i ett 3rd-partiet åtkomstkontrollsystem genom XPressEntry Data Manager.

SDK-enheten är implementerad som en .NET WCF-tjänst. Vi tillhandahåller ett enkelt klientgränssnitt (XPressEntrySDKServiceInterface) som kan användas för att ansluta till SDK.

Detta gränssnitt implementerar följande samtal: #

XPressEntrySDKServiceInterface Constructor med dessa parametrar:
Hostnamn (eller IP), Användarnamn, Lösenord. Användarnamnet / Lösenordet är inställt inom XPressEntry och används för att konfigurera vilka konton som kan komma åt SDK.

SDK har 4-händelser #

ActivityCreated - När Badge-aktiviteter läggs till i XPressEntry direkt eller via en datahanterare
DataObjectsChanged - När dataobjekt ändras i XPressEntry direkt eller via en datahanterare
DataObjectsDeleted - När dataobjekt raderas i XPressEntry direkt eller via en datahanterare
OnServiceStatusChanged - När SDK-tjänsten är ansluten eller frånkopplad.

Händelsehantering: #

SubscribeClient () - för att prenumerera på din SDK-klient för att ta emot händelser
UnsubscribeClient () - för att avregistrera din SDK-klient från att ta emot händelser

SDK implementerar en minimal uppsättning datahämtnings- / modifieringsfunktioner. #

För hämtning:
FindDataObjects - Hämtar en lista med dataobjekt från XPressEntry
GetDataObject - Hämtar ett enda dataobjekt från XPressEntry med hjälp av fältet XPressEntry id
GetDataObjectByExternalID - Hämtar ett enskilt dataobjekt från XPressEntry med det externa ID Manager-fältet

För modifiering:
UpdateOrCreateDataObject - Skapar eller modifierar ett objekt i XPressEntry.
DeleteDataObject - Både borttagning av XPressEntry ID / DataManager Extern_ID stöds