Other Services
The Authentication Service allows validation of user access to any site using a username and password.
The Scheduled Export Service is a series of APIs that Crunchtime customers can use to get, download, and mark export files that have been generated via Scheduled Events in Enterprise Manager (EM). The download response will consist of and convert the batched data into JSON. This service allows for increased flexibility and options to expose data via API. Anything that can be exported via EM, can also be exposed via API
Generating an export batch is done in EM and can be done in two ways:
- Manually via EM > Interfaces > Outbound Integrations
- Automated via EM > Interfaces > Event Scheduling (Additional instructions for Event Scheduling)
Each time a manual or automated batch is generated, a snapshot of the data available is exported at that time and assigned a Batch Number. Thereafter, the process for cycling through the API calls are as follows:
- The /getAllScheduledExports endpoint gets all batches available for download. Check here first to see if any new batches are available
- The /downloadScheduledExport endpoint is then used to expose the contents of one particular batch in JSON format
- the /markScheduledExport endpoint updates the export status in EM to "CDP Yes". This is your visual representation in the UI that this batch was accessed via API. In addition, you can filter by status in the /getAll endpoint. Using the /mark endpoint allows you to exclude these batches in future /getAll calls
The export status codes are as follows:
(1) Returns records for manually created exports
(2) Returns records for exports created via the Event Schedule
(3) Returns already downloaded records
(5) Returns records Marked but not downloaded exports
The User Defined Attributes (UDA) Service allows for the retrieval of the location and vendor User-Defined Attributes (UDAs) that are defined either at the corporate level or specific to a particular location.
Updated 4 days ago