Bulk Import via API Setup - System Admin
The Bulk Import API for System Admin offers institutions a powerful solution to streamline data management. This article outlines its key benefits and the sequential steps for implementation, along with an estimated timeline.
System administrators and IT staff - be sure to download the System Administration Bulk Import API Instructions - PDF at the bottom of this page.
Key Benefits:
- Reduced Manual Effort: Directly upload from your institution's file directory.
- Automated Imports: Schedule recurring file transfers, eliminating the need for manual UI logins.
- Efficient Handling: Process large data files with enhanced bulk import capabilities.
- Clear Status Tracking: The API provides basic statuses: In Progress, Completed, and Failed.
Implementation Steps & Estimated Timeline
| Steps | Description | Action Done by: | Estimated Time |
|---|---|---|---|
| 1. API Review and Preparation | Download and review the API PDF with your IT Team (available at the bottom of this page). | Institution | 1-2 days |
| 2. Sandbox Account Setup Request | Submit a support request for a Sandbox account and be sure to include:
| Institution | 1-2 days |
| 3. Environment and Sample Code | Creates Sandbox, sets up permissions, and sends any requested sample code to the institution. | Watermark | 2-4 days |
| 4. Initial API Setup | Create API connection in System Admin. Prepare test data, ensuring emails in the Sandbox are anonymized. Keep data size minimal when importing into the Sandbox, only a small amount is needed to test the API connection. See API PDF for details and troubleshooting. | Institution | 3-14 days |
| 5. Test API Imports and Integrations | Build automation logic, conduct testing in the Sandbox, and verify data integrity. | Institution | 5-10 days |
| 6. Request API for Primary Account | Follow up with Watermark Support to enable API on your primary account. | Institution | 1-2 days |
| 7. Configure API | Disables API and removes permissions to the Sandbox. Enables API on the institution's primary account. Confirm the update. | Watermark | 1-2 days |
| 8. Validate in Primary Account | Perform final validation of the Import API within your Primary Institution to confirm functionality. | Institution | 1-2 days |
| 9. Ongoing Monitoring | Conduct regular status checks and review logs to ensure continuous data accuracy and successful imports | Institution | Continuous |