Skip to main content

Communication Format

Identification & Protocol

The Rekonect API communicates through secure HTTP POST requests over HTTPS. Each client receives a unique API key upon registration, which must be included in the headers of every request to ensure authentication.

Encryption

TLS version 1.2 or above is required to interact with the API securely. Older versions (TLS 1.0 and 1.1) are deprecated due to known vulnerabilities and should not be used.

Rekonect API Servers

Host: https://api.prod.bcomo.com

Note: When a static IP is required, please contact our integration team at pos@comosense.com.

Request Format

The POST body must be a UTF-8 encoded JSON object. The URL for the request should be structured as follows:

https://api.prod.bcomo.com/api/v4/apiCall?apiCallParameters

ComponentDescription
API server hostThe base domain of the API
Prefix path + callAPI version path and the specific API call name
Query parametersOptional parameters relevant to the API call

Request Headers

HeaderDescriptionTypeRequired
Content-TypeThe request payload content type (application/json)StringYes
X-Api-KeyAPI key used for authenticationStringYes
X-Branch-IdBusiness branch identifierStringYes
X-Pos-IdPOS terminal identifier that initiated the requestStringYes
X-Source-TypeOrigin of transaction (e.g., POS, Website, Kiosk)StringYes
X-Source-NameName of the integration source (e.g., POS system name)StringYes
X-Source-VersionVersion of the integration client or systemStringYes

Response Format

The API returns a JSON response object. The status field indicates whether the request succeeded (ok) or failed (error). If an error occurs, the response will include an errors array with detailed diagnostic information.

Error Response Fields

FieldDescriptionTypeAlways Returned
codeUnique error codeStringYes
messageDescription of the errorStringYes
causeAdditional context about the errorObjectSometimes

Example Error Response

{
"status": "error",
"errors": [
{
"code": "4001012",
"message": "Customer(s) not found"
}
]
}