Export API: Overview
Introduction
Section titled “Introduction”This document provides detailed information about the export endpoint for retrieving Sales information of a Caspeco customer using the Caspeco Sales Export-API. It covers the best practices, restrictions, authentication requirements, endpoint details, return data formats, and field descriptions.
Best Practices and Restrictions
Section titled “Best Practices and Restrictions”To ensure smooth operation and fair usage, please adhere to the following best practices and restrictions:
- There is a default limit of 100 requests per day for every authentication token. Please ensure that you stay within this limit.
- Avoid requesting historical data that has already been retrieved unless necessary for restoring or correcting previous retrievals in your system.
Authentication
Section titled “Authentication”To access the Caspeco Sales Export-API, you must include the custom header AuthKey in your requests. This header should contain the authentication token provided to you by Caspeco or through the shared customer.
AuthKey: <YourAuthKeyHere>Endpoint
Section titled “Endpoint”The endpoint URL for retrieving data is as follows:
https://salesapi.caspeco.net/api/sales/<system>/<date>Replace <system> with the Caspeco internal system name for which you want to retrieve data. Caspeco will provide you with this information along with the authentication token.
Replace <date> with the business day defined by Caspeco. It corresponds to sales made between 06:00:00 on the specified date to 05:59:59 on the following date. The date must be in the format YYYY-MM-DD.
Return Data Formats
Section titled “Return Data Formats”You can choose to receive the return data in two different formats: JSON or CSV. If you prefer CSV format, include the following headers in your request:
Accept: text/csvAccept-Encoding: gzip, deflate