Batch API
Website personalisation: Sending data to Ometria
Ometria Web Personalisation's batch API is designed to facilitate the processing of large sets of data.
Its primary purpose is to allow for a full data synchronisation.
There are four steps in the Batch API workflow:
Extract data
Extract data from your system into four separate files:
- categories.json - An output of all categories in a single JSON file.
- products.json - An output of all products, including prices, attributes etc.
- pages.json - An output of all page/static content.
- definitions.json - An attribute definition schema.
All files are JSON in format and should be written with a .json extension.
Zip
Zip your files into one compressed file.
Generate a MD5 hash of the final compressed file.
See also: Batch API upload and processing
Upload and verification
Access to the Batch API is restricted and all requests are authenticated using basic authentication.
The zip file is attached as a file to a POST API call.
The post request must supply the MD5 hash verification.
The service generates an internal MD5 hash of the received content and validates the value supplied in the request.
Successful uploads will return a receipt id.
See also:
Process
After the catalogue data has been successfully uploaded you'll need to send a request to process the uploaded content.
The put request must include the receipt ID supplied in the previous call to validate the process request.
Updated 2 days ago