Each POS terminal includes a built in mini web server for maintainance purposes and there are APIs available over this interface which allow you to create web applications that interact with the dynamic state. The Web API is exclusively for interacting with selling counters and the selling process, if you are wanting to interact with the system generally, see eLink Documentation
The Web API also has an older legacy support mode, which uses a slightly different structure and is documented here
Use Web API for:
- Browser based Customer Displays showing information about the active sale
- Browsers embedded in the operators UI to display specialised sale information
- Capturing and validating data in a web page that should be attached to the current sale, such as complex forms.
- Creating remote monitoring applications for individual lanes
Do not use for:
- Interfacing to external systems
- Creating and completing sales without human interaction
- Bulk data extract or insertion
- Connections from the Internet into a trading lane. These are generally already blocked by firewalls and we will actively try and block any attempts to circumvent this.
URL and Security
This page assumes that the POS is running on the local machine on port 8095. All examples use http://127.0.0.1:8095 as the server address. This may not always be the correct port. If you are browsing from a different machine you will need to know that POS lanes IP address - which may be problematic as many POS lanes are using DHCP addressing
Responses will be XML by default, but you can request JSON format response by inserting a reply type in your request.
Retrieving Current Sale Details
<ARAY> <DATS> <f108>0</f108> <f115>0</f115> <f117>0</f117> <f120>4565.000000</f120> <f122>521</f122> <f123>16777262</f123> <f125>2</f125> <f600>HTTP://MEETU4.COM/$M0...</f600> <f601>0</f601> <LINE> <f200>11</f200> <f201>0</f201> <f202>1</f202> <f203>0</f203> <f205>4565.000000</f205> <f206>1</f206> <f213>1</f213> <f2000>Pacific Grove Suite (5)</f2000> </LINE> </DATS> </ARAY>
Retrieves information about the current foreground sale the operator is working with.
The number and range of fields that can be returned is large.
May Contain:
- Salelines - Items being sold. /docs/elink/appt_21_1.htm
May Contain:- Work. Actions still to be performed on this item
/docs/elink/dt_work.htm
- Work. Actions still to be performed on this item
- Payments - /docs/elink/dt_payment.htm
May Contain:- Allocations. Details of where payment has been
explicitly allocated to salelines /docs/elink/dt_allocation.htm
- Allocations. Details of where payment has been
- Delivery Information
- Notes, wiki like general notes on sale. /docs/elink/dt_notes.htm
Technical note: Sale Objects may repeat information in multiple fields. Internally sales are represented using nested structures but these can be complex to work with, requiring loops and additional code. Therefore many common fields are repeated at higher levels to make other applications easier and less error prone to create.
Major Fields
Retrieving Current System State
<ARAY> <DATS> <f200>644</f200> <f201>662</f201> <f202>662</f202> <f203>2014|7|12|14|19|52||</f203> <f230>0</f230> <f231>send(42,kp)</f231> <f240>0</f240> <f241>2.10-5.1811 (2000a:50713)</f241> <f242>521</f242> <f243>2</f243> <f244>2</f244> <f245>64</f245> <f246>1</f246> <f247 /> <f248 /> <f400>0</f400> <f401 /> <f500>246</f500> <f501>MAIN</f501> <f502 /> <APPD> <f120>Wrong password</f120> <f121>2014|7|12|13|42|43||</f121> </APPD> </DATS> </ARAY>
Retrieves information about the current internal state of the Point Of Sale engine
The fields returned are:APPD child packets may be included as an array of 0...N elements.
Legacy Interfaces
The following interfaces are present and can be used but are no longer being actively enhanced.
Product.xml
A request to the url http://127.0.0.1:8095/webx/product.xml?pid=NNN will return the current database information for pid NNN. This information can only be returned in XML format. This url is unlikely to be added to other Fieldpine trading applications.
http://127.0.0.1:8095/webx/product.xml?pid=644 <product> <pid>644<pid> <description>Airfare<description> <unitprice>19.99<unitprice> ... </product>Data Model 1
The data model 1 interfaces allows you to retrieve the current value of any data model value. You can only retrieve set versions of data models are not permitted. To request a Data Model value, create a URL with the following structure
http://127.0.0.1:8095/fdldm1/data-modelTo be clear, the url path contains ( Fox-trot, Delta, Lima, Delta, Motel, One )
The fdldm1 interface contains a simplified HTTP return packet and may not be easily useable from all browsers.
ExamplesCurrent Price of product 644 http://127.0.0.1:8095/fdldm1/product.644.unitprice 19.99 Sale id of active, on screen sale http://127.0.0.1:8095/fdldm1/activesale.sid 8451665 Value of current active sale http://127.0.0.1:8095/fdldm1/activesale.total.value 37.89 Name of customer, if a customer is connected to the sale http://127.0.0.1:8095/fdldm1/activesale.customer.name Ella K Name of UI screen currently active. Only base UI level screens are returned not built in screens. http://127.0.0.1:8095/fdldm1/activescreen.basename main List of tables present in the database http://127.0.0.1:8095/fdldm1/database.tablelist accounts,barcodes,customers,products,sales ....Management Interface
The management interface is provided for management and support purposes only. Its operation is not guaranteed. The following URLs can be useful from a support perspective.
Use of the following URLs may not be legal in all environments. Obtain independent advice if uncertain. These URLs are not enabled by default and require additional (freely available) dlls to be installed. We do not ship these dlls by default.
http://127.0.0.1:8095/fdlmgmt/fdlmgmt_camera_0.jpg
Returns the latest photo captured by the camerahttp://127.0.0.1:8095/fdlmgmt/ss_0.jpg
Takes a screenshot and returns a jpg image. The final digit (0 is shown above) controls the size and scale of the returned image. Values 0,1,2 and 3 are currently enabled (P1901)