Data interfaces
Guper integrates with many external systems — Bling, VTEX, Linx, Shopify, and others. Each integration is called a Provider, and within each provider there are different Sources that represent the origin of the data.
To organise and standardise information from these systems, Guper uses a concept called Data Interface. An interface acts as a translator between the external system's data and the format expected internally, ensuring identifiers from each platform map to the right entities.
How interfaces work
Each interface has a unique identifier within Guper. When configured, it defines a mapping between the source system's data and Guper's internal data.
Example:
- Interface —
xpto1(unique identifier of the interface within Guper) - categoryId —
45asd-5(category ID in the source system)
After processing through Guper's translator, the data is structured as:
{
"translatedFrom": "xpto1",
"categoryRefId": "45asd-5",
"categoryId": 563
}
| Field | Meaning |
|---|---|
translatedFrom |
Identifies which interface performed the conversion. |
categoryRefId |
The reference ID of the category in the external system. |
categoryId |
The standardised internal ID recognised within Guper. |
This model ensures that data coming from different providers is converted correctly and can be used in a unified way.
When you'll see this
Most Guper API requests accept an interface field at the root of the payload (e.g. "interface": "generic" or "interface": "vtex"). That field tells the engine which translator to apply to the IDs you're sending.