FD1 Client Protocol
 
Library Developer Home FD1 Client Protocol Home Concepts Reading Data Writing Data Protocol Defined Servers Connect & Authenticate Proxies & Tunnels
Webhooks & Firehoses 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 Get Attribute 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 PosGreen 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

Customer Access

Often you will want to allow a customer or untrusted third party to access a specific subset of data. FD1 is designed to allow this with row/field level security in the API itself.

Customer Display

Customer uses their own phone to watch the sale as it progresses

Online Receipt

Allow a customer to retrieve their receipt, optionally getting additional product details or downloading the receipt in alternative formats

Purchase Order

Allow a supplier to interact with a purchase order

In Store Search

Implement navigation and search while in the store

General Operation

Customer:
  • Scans a QR code, which is a URL
  • Clicks a link in an email
  • Clicks a link in a TXT message
Customers browser loads the URL, a public web page, which can be on your website/domain
That web page opens websocket to your Retail Server and sends the original URL as part of fd1.session.login
The QR code acts as a short term restricted access API Key

Example page showing the QR landing page