NAV Navbar
  • Introduction
  • Overview
  • KDS Cloud
  • Introduction

    The Fresh Technology Integrations API allows for outside parties to send and pull data from the Fresh Technology systems.

    Setup

    Before someone can begin to integrate with the Fresh Technologies Integrations API, please contact Austin Fabel at Fresh Technology to discuss your integration and next steps.

    Getting Started

    Production

    If you are creating an integration for your own use, the above steps will need to be repeated on the Fresh Tools Production environment Fresh Tools. If your integration is intended to be used by your customers, the customer will need to follow the steps above on their Tools account and supply you with the integration token. Tokens are assigned at the account level and will be unique per customer.

    The Integration token will be required for all calls to the Integrations API, if the token is not valid, or has been revoked, the request will fail with a 401 (Unauthorized).

    Overview

    Be sure to check the HTTP syntax to see what headers are required to be sent. Some routes require different headers, however all requests will require the integration token to be sent.

    Environment URL
    demo https://demo-integrations-api.ftservices.cloud
    production https://integrations-api.ftservices.cloud

    Authorization

    Every request on the Integrations API requires 1 header sent.

    KDS Cloud

    KDS Cloud allows for outside integrations to send orders to be displayed on FreshKDS screens. Through the use of KDS Cloud, orders can be sent from any third party system whether on premise or cloud based with the granular control over which screen(s) will receive the orders.

    Get KDS Information

    GET /integrators/kds-information HTTP/1.1
    https://demo-integrations-api.ftservices.cloud
    x-integration-token: pUiVhtLDbqmYG312IEJ0UDcjhWXhivXKiZxwoNWBJPeFTDCaZHs7UQgoVKtFLeCt6sJ572WD0Xnh10l2baOiph
    
    HTTP/1.1 200 OK
    content-type: application/json
    
    [
        {
            "id": "81db5db1-b5af-4e45-8767-71fb78e29bdb",
            "name": "Test Location Fresh",
            "address": {
                "zip": "12345",
                "city": "Any Town",
                "line1": "123 Test Lane",
                "line2": null,
                "state": "NV"
            },
            "timezone": "US/Pacific",
            "devices": [
                {
                    "id": "ef837416-c674-40ab-9aa3-eb0f202e8646",
                    "name": "Device 1"
                }
            ]
        }
    ]
    

    GET /integrators/kds-information

    Get KDS Locations

    GET /integrators/kds-information/locations HTTP/1.1
    https://demo-integrations-api.ftservices.cloud
    x-integration-token: pUiVhtLDbqmYG312IEJ0UDcjhWXhivXKiZxwoNWBJPeFTDCaZHs7UQgoVKtFLeCt6sJ572WD0Xnh10l2baOiph
    
    HTTP/1.1 200 OK
    content-type: application/json
    
    [
        {
            "id": "81db5db1-b5af-4e45-8767-71fb78e29bdb",
            "name": "Test Location Fresh",
            "address": {
                "zip": "12345",
                "city": "Any Town",
                "line1": "123 Test Lane",
                "line2": null,
                "state": "NV"
            },
            "timezone": "US/Pacific"
        }
    ]
    

    GET /integrators/kds-information/locations

    Get KDS Devices

    GET /integrators/kds-information/locations/81db5db1-b5af-4e45-8767-71fb78e29bdb/devices HTTP/1.1
    https://demo-integrations-api.ftservices.cloud
    x-integration-token: pUiVhtLDbqmYG312IEJ0UDcjhWXhivXKiZxwoNWBJPeFTDCaZHs7UQgoVKtFLeCt6sJ572WD0Xnh10l2baOiph
    
    HTTP/1.1 200 OK
    content-type: application/json
    
    [
        {
            "id": "ef837416-c674-40ab-9aa3-eb0f202e8646",
            "name": "Device 1"
        }
    ]
    

    GET /integrators/kds-information/locations/{locationId}/devices

    URL Parameters

    Property Description
    locationId Location ID

    KDS Order

    POST /integrators/kds-orders HTTP/1.1
    host: https://demo-integrations-api.ftservices.cloud
    x-integration-token: 1234567890
    x-location-id: 5fcbcc8c-d637-4d91-a576-9de31ffe7a3d
    x-device-ids: 319fb5bc-6189-4dc6-a1e0-42dbf36177e9 (Comma delimited for multiple devices, value of 'all' for all active devices at location)
    
    HTTP/1.1 200 OK
    content-type: application/json
    
    [
        {
            "orderId" : "d2874775-34e2-4829-8b59-1260e40eca4e"
        }
    ]
    

    POST /integrators/kds-orders

    Additional Headers

    Body Parameters

    KDS Order

    Property Required Type Description
    id yes string Integration order id
    name yes string Order Name/Number
    time yes long ISO8601 formated date/time (Terminal Local) (YYYY-MM-DDTHH:MM:SS)
    mode yes string Order Mode (For Here, ToGo, Pickup, DriveThru, Delivery, CurbSide) note: if invalid order mode, mode will be added to order name
    server no string Server Name
    items yes KdsItem[] Items
    terminal yes string Pos Terminal
    vehicleModel no string Car Model
    vehicleColor no string Car Color

    KDS Item

    Property Required Type Description
    name yes string Order Name/Number
    qty yes int Quantity
    mods yes string[] Item Modifiers, empty array if none