FD1 Client Protocol
 
Library Developer Home FD1 Client Protocol Home Concepts Reading Data Writing Data Protocol Defined Servers Connect & Authenticate Proxies & Tunnels
Webhooks Programming Support Logging Minor Facts State Facts Response Format How To Guides eCommerce Sites Custom Point of Sale Customer Access Bulk Downloads Major APIs / Endpoints All Endpoints Products Sales SalesBuilder Session Sale Capture General Purpose Data Capture Devices Barcode Scanners Eftpos IoT Sensors Power Outlets Printing Scales Security Cameras Purchasing / Supply Side Purchase Orders Invoices Invoice Payments Document Capture Rare APIs / Endpoints SSL Certificates API Key Management Diagnositics Server to Client Messages Overview Resources / Objects Purchase Order Invoice Payable Invoice Payment Product Supplier Location Sale Lines Sale Delivery Details Sales Price Maps Employees Carriers Payments Product Kits Department 1 Customers

FD1 Servers

FD1 is spoken by many components within a Fieldpine installation. Fieldpine is fundamentally a distributed platform that consists of standalone apps talking to store and head office servers, which may be inhouse, self hosted or cloud based. Regardless of where the server is, you as a developer will connect to one or more FD1 Servers; typically this is Head Office or a Store Server.

Head Office
Server
FD1 Server
 Fail Over
Server(s)
FD1 Server
 
Store A
Server
FD1 Server
 Store B
Server(s)
FD1 Server
 External Ingest
Server
FD1 Server
Checkout
One
FD1 Server
 Label Printer
FD1 Server
 External Website
FD1 Server

Head Office FD1

Head Office Servers run complete access FD1 servers with the ability to implement almost every endpoint.

Proxy FD1

FD1 servers can be installed outside the normal retailer network in places like website providers. When used in this mode, FD1 acts as a local caching proxy, which can reduce server load and decrease call latency.
Data stored in external sites is limited to what they have access too, not all data is maintained remotely.

Device FD1

FD1 servers can be installed to provide access to local devices, such as printers, scales or other resources. These servers do not typically have access to data and are limited to device interaction.

Ingest Server

Fieldpine provide internet facing servers, per retailer, that can receive a subset of FD1 calls. It has limited read access and is basically restricted to public data

  • Domain names are https://retailer-name.online.fieldpine.com where retailer-name is allocated by Fieldpine
  • Using a different domain to the retailers primary servers helps divert hacking to sacrifical hosts, which do not store any sensitive data long term
  • These servers are intended to provide an easy way to receive data or publish publically available data

Examples of use: Rate our Service customer feedback