Cloud POS Data Export/Intelligence API

Welcome to the Cloud POS API documentation. By using the API, you agree to the Terms and Conditions outlined on the API homepage.

Getting Started

• Base URL: https://intelligence.citruslime.com/BI/
• All requests must use HTTPS and include your API Key as an Authorization header.
• The content type must be set to application/json.
• For endpoints that accept FromDate and ToDate, you can pass one or both.
• To filter results using timestamps, append ?timestamp=123456 to the request.
• Note: The timestamp represents the RowVersion, which updates when a record is created or modified. This allows you to filter for records that have changed since your last request.

Example API Request

Here’s an example of making an API request using cURL and JavaScript:

curl --location 'https://intelligence.citruslime.com/BI/Department.aspx'
                    --header 'Authorization: YOUR_API_KEY'
                    --header "Content-Type: application/json"

fetch('https://intelligence.citruslime.com/BI/Transaction.aspx?timestamp=123456', {
    headers: {
        'Authorization': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
})
.then(response => response.json())
.then(data => console.log(data));

Example Workflow

To effectively manage data retrieval, follow this two-step approach: an initial synchronization to load historical data and an ongoing sync process to fetch newly added or modified records.

The first step is to load past data incrementally while ensuring that no records are processed twice. We achieve this by storing a timestamp value that marks the most recent record retrieved. This approach allows handling failures gracefully, as data processing can resume from the last stored timestamp.

// Store the last processed timestamp
var maxTimestamp = storeGet("maxTimestamp"); // Persist this value

// Loop through historic data in daily increments
loop process each day:
    data = intelligence.citruslime.com/BI/Transaction.aspx?FromDate=30/07/2018 15:00&ToDate=01/08/2018 00:01;

    foreach record in data.orderBy(timestamp):
        if (record.timestamp >= maxTimestamp):
            processRecord(record);
            maxTimestamp = record.timestamp;
            storeSave("maxTimestamp", maxTimestamp);
        end if;
    end loop;
end process;

Once historical data is synchronized, subsequent API calls should retrieve only new or modified records. This is done by querying records that have a timestamp greater than the last stored timestamp. The process ensures minimal data transfer and optimizes performance.

data = intelligence.citruslime.com/BI/Transaction.aspx?timestamp=maxTimestamp;

foreach record in data.orderBy(timestamp):
    if (record.timestamp >= maxTimestamp):
        processRecord(record);
        maxTimestamp = record.timestamp;
        storeSave("maxTimestamp", maxTimestamp);
    end if;
end loop;