Sales Integration Manual 🛍️
The integration between the AlterVision system and the stores’ POS/ERP systems aims to import each store's sales data into the platform. This document clearly outlines the ways in which store systems can integrate with our system.
Overview of Integration Methods
We present four ways to perform the integration, mainly differing in how data flows between the systems. In the Push model, the client sends the information directly to our platform, allowing greater control. In the Pull model, our platform periodically queries an API provided by the client. In the Third-Party API model, the data is obtained from an external provider that already integrates with the AlterVision system. Finally, manual import allows you to input data through CSV spreadsheets via PainelAlter.
Method 1: PUSH - The client sends data to AlterVision
How it works
The client implements a routine (job, webhook, or service) that sends sales data to a secure endpoint on our platform. Once received, these records are validated, deduplicated, and presented on the dashboard for reporting and analysis.
More information
Access the full documentation in API Documentation
When to choose
Recommended when the client wants low latency (near real-time data), full control over which records leave their environment, and prefers to manage the sending process internally.
Benefits
No fixed IP or port forwarding required—only outgoing connections are used. Greater control over shared information.
Challenges
The client is responsible for developing the sales data sending routine and ensuring data is sent reliably (automatic resending in case of errors, for example).
Method 2: PULL - Data is obtained via the client’s API
How it works
The client develops and exposes an API capable of returning sales data. Our platform periodically queries the provided endpoint to collect sales.
More information
Access the Schema for integration with AlterVision via API.
When to choose
When the client already has similar integrations with other systems or when internal policies prevent creating or maintaining automated sending routines.
Benefits
No need to maintain routines or servers; only API maintenance is required.
Challenges
Dependence on the client API’s availability and performance, and the need to handle authentication, rate limits, and pagination.
Method 3: Third-Party API - Data is obtained from a third party
How it works
Our platform retrieves sales directly from the API of the POS provider that the client uses. Instead of the client building a new routine, we consume the data already made available by the POS provider.
When to choose
When the client already uses a POS with an available API and prefers to leverage this ready source to reduce internal work, or when the POS provider is the sole reliable source of sales records.
Benefits
Reduces client effort by leveraging the POS API, speeding up integration and facilitating standardization.
Challenges
Depends on the availability and changes of the provider’s API, which can affect data updates and consistency, and may require coordination for support and credentials.
Method 4: Manual Import
Manual import allows sales data to be entered into the system by uploading a CSV spreadsheet. This method is ideal for scenarios where the data is already organized externally or when no automated integration is available.
To use this feature, access PainelAlter and navigate to Quick Shortcuts > Import Sales > Upload Spreadsheet. In this section, you can download the standard CSV templates, which should be used as a basis to ensure the data is in the correct format.
After filling in the spreadsheet with the required information, simply upload the file in the same area. The system will process the data and perform the import automatically.
We strongly recommend strictly following the provided template, respecting the column names and data formats, to avoid errors during processing.