Please refer to the Authentication page for information on obtaining the API Key and Client Secret necessary to use the Data Integration webhook.
To publish (POST) data to the webhook, users must have the following elements present in their http request:
1. Webhook URL
2. Header
The Solink API uses standard API authentication. Users must provide the authentication token and client secret as request headers in order to submit the data to the Solink API.
The header must include the following:
x-api-key: The API user’s assigned confidential API Key, provided by Solink. Each organization will receive a single API Key, which can be used to post data for multiple users/sitesAuthorization: The user's Bearer access token, provided when you Create Access Token.Content-Type: ‘application/json’
The body must contain a properly formed JSON object conformant to one of the Solink standard object models based on the type of data.
x-api-key: <Assigned API key>,
Authorization: Bearer <accessToken>,
Content-Type: application/json
3. BODY
The body must contain a properly formed JSON conformant to one of the Solink standard object formats based on data type, outlined below.
A standard Solink object typically consists of two main sections: event metadata and item details. Item details are specified in an items array and are used for storing time-stamped items, payments and other pertinent actions. Event metadata includes the fields that describe the transaction in terms of the owner, transaction types and subtypes, the date(s), the data sources and other top-level descriptors.
The set of typical fields vary depending on the user’s POS system and use cases. Here are some Solink API standard data formats:
It is the sender’s responsibility to ensure that they provide data with the correct field names as other field names will not be processed and may result in an error during the request. However, Solink provides flexibility to evaluate and potentially add new fields and data schemas based on specific customer requirements or new use cases. If you have additional field requirements that aren’t part of the standard schema, reach out to Solink’s API support team.