FD1 Client Protocol
Library Developer Home FD1 Client Protocol Home Conceptual Overview Using GET/POST Protocol Definition Authentication Authorisation Firehoses Examples General curl websocat Major APIs / Endpoints Endpoint Overview Accounts Customers Fetch Data Departments Devices Locations Products Sales Session Less Common Endpoints User Interface Worked Examples Temperature Monitor Custom Report Instore Customer Display External Customer Display Cross Domain Reporting Advanced Integration FieldpineDevices External Website Schema Definitions custdisp.sale.* device.bluetooth.announcement device.scale.reading firehose.status sale.create sale.read Diagnostic Schema tufe.error tusp.entry

FD1 Session Endpoint

Authenticates your client session to the server. This must be sent first when opening a websocket.

Fields

FieldDescription
apikeySends your APIKey.
tokenSends your token. Used for short term authentication
encryption_userBeta Testing.
Optional Fields
tzUsers timezone. Collected in browser using 
tz: (new Date()).getTimezoneOffset()
localtimeUsers localtime. format "YYYY-MM-DD HH:mm:SS.ccc" Collected in browser using 
let myDate = new Date()
localtime: myDate.getFullYear() + "-" + (myDate.getMonth() + 1)
                + "-" + myDate.getDate() + " " + myDate.getHours()
                + ":" + myDate.getMinutes() + ":" + myDate.getSeconds()
                + "." + myDate.getMilliseconds()
geo

fd1.session.login

  • Must provide one, and only one, of apikey, token, or encryption_user

Example

{
    a: "fd1.session.login",
    v: {
        apikey: "my api key",
        tz: myDate.getTimezoneOffset(),
        localtime: myDate.getFullYear() + "-" + (myDate.getMonth() + 1)
            + "-" + myDate.getDate() + " " + myDate.getHours()
            + ":" + myDate.getMinutes() + ":" + myDate.getSeconds()
            + "." + myDate.getMilliseconds()
    }
}