Library OpenApi Overview About these APIs Architecture Authentication Error Responses Locating a Server Sessions Design Guides Guides and Hints Examples Pricing for Websites Accepting Vouchers PreAuth Payment Replication Common Apis The most used APIs Create New Sale Payment Completion Multiple Locations Delivery Addresses Create New Sale v2 Customers Locations Products Staff WebHooks eCommerce Apis These APIs are often used with eCommerce website integrations Get Pricing Card Inquiry Report & Analysis Grouped or analysed report data. Typically used to build reports and dashboards Today Login Access Pinboard ReportRequest Advanced Information More indepth information Caller Handling HTTP Protocol Bulk Data Downloads Document Uploading RetailConfig Under Development Details of APIs that will be available shortly. Documentation provided is for early adopters Get Receipt

OpenAPI Sessions

Some OpenApi functions work with a session. A session is an individual browser or device that is interacting with Fieldpine. You do not need to create a session yourself as one will be automatically created for you.

Sessions are not common or required for the vast majority of OpenApi use. Mainly they are required if you are using OpenApi to communicate directly with PosGreen trading registers at the front counter. A session helps that Pos understand if your API call relates to the interactive Pos, or is a background parallel operation.

Several functions allow you to specify the session for the function being executed. If you do not supply any value them your session is used, however if you provide an explicit session identifier then that session is used instead.

Quick Examples

A browser on a mobile device capturing sales

Where the device is creating and managing sales itself, ie it is the POS checkout, then you do not need to specify a session identifier. Functions will automatically use your private session and you will be isolated from other active sales.

A browser providing a customer display

If you have a web based customer display interacting with a sale actively being rung up on a device then the browser needs to specify a session, so that the server knows which sale is to be displayed.

A web page within PosGreen used to capture information

Often PosGreen (Windows based standalone Pos) will display a web page to capture information for the sale. For example selling an item might briefly open a captive web page to capture serial numbers or details for warranty purposes. As these web pages are part of PosGreen you do not need to provide a session identifier and will automatically be connected to the current Windows session.

Head Office remotely watching active sales

A head office monitoring application might call into each store to monitor sales in realtime. In this case the application will need to provide a session identifier to enumerate over all the sessions.