The Real-Time API Data Ingestion feature allows API-connected customers to use the Data Ingestion Assistant in Workbench to instantly fetch and preview the latest bill data without manually uploading files for testing purposes only. API clients must continue manually uploading XML files to define data paths in Workbench.
This enhancement removes a key adoption barrier for API-based integrations, making mapping validation faster, easier, and self-service. However, path extraction still requires a manual XML uploadWith this feature, admins can:
Enter an account number to retrieve the most recent bill via API.
Validate mapping updates instantly using the retrieved bill.
How To Use It
From the left-hand side menu bar, click on the Workbench icon to open the mapping workspace.
Select Data Mapping. The Data Mapping page lists all configured mapping rules for your billing data transformation.
Locate the Preview Bill button in the top-right corner of the Data Mapping page. This option is used to retrieve and preview bill data for validation.
In the Account Number field, type the account number you want to test. This account must exist in your connected billing system and have bill data available.
Click on Open Preview to request the latest two bills from the client system via API.
This API based fetch is for testing purposes only and does not replace the standard ingestion used for live Bill Explainer.
A status message will indicate whether the bill was retrieved successfully or if an error occurred. If the bill was retrieved successfully, the bill will appear in the Explainer view.
The preview reflects the most recent data retrieved from the client system. Review the bill preview to ensure all mapped fields and transformations display correctly.
If the preview is correct, click on the Publish Mapping to make the updated mapping active. The changes will be reflected in the Bill Explainer microsite without needing engineering assistance.
The real-time API fetch is designed for preview and validation during setup. You can publish mapping updates after a successful preview, but this API call is not the method used for live bill delivery in the Explainer microsite.
On the Bill Explainer Microsite, bills are still retrieved using the standard ingestion process.
Key Benefits
Faster Testing: No need to manually upload previous and current month bill files.
Improved Accuracy: Preview data matches real-time billing information from the client’s system. Spot discrepancies before publishing.
Self-Service: Admins can validate and publish mapping updates without engineering assistance.
Reduced Support Load: Services teams spend less time assisting with mapping validation.
Important Notes
Supported Formats: Only standard XML schemas (For Example: XSD) are supported. Custom formats may not work.
Path Extraction Still Requires Upload: API clients must continue manually uploading XML files to define data paths in Workbench.
Testing Only: The API fetch is for preview and validation during setup. It does not replace the production data ingestion process for the Explainer microsite.
System Monitoring
For reliability, each API ingestion attempt is logged with basic metadata. For Example: timestamp, success/failure, data size
If the failure rate exceeds a defined threshold, developers teams receive alerts and can access detailed logs for troubleshooting.