Bulk Importing CSV files in a ZIP with an API

Bulk Import via API

The bulk import API can save time by removing the need to log in to System Administration in order to import core data, thus decreasing manual tasks.

It provides a basic status response of Pending, Completed or Failed.

Once an API Import status has moved to either Completed or Failed, additional details are provided within System Administration’s Data Transaction section, which include details on import and integration status as well downloadable CSV error reports.

Setting up API

API setup is not required although it will ultimately reduce manual work.

If interested in setting up an API, download and review the PDF guide attached below. It will walk you through the process of configuring API imports.

Watermark also has sample code available in: swagger docs, postman, curl, java and python. To request this sample, contact Watermark Support by clicking Submit A Request.

Be sure to include all relevant information so that your request can be routed quickly and accurately, using Subject "System Administration Bulk API Sample Code".

Testing the API Connection

After having reviewed the API PDF Guide and getting any sample code, contact Watermark Support through a request, and let them know you are ready to Enable the Import API for your Institution’s System Admin instance.

Once Watermark Support confirms your Import API has been enabled, you can start to test the connection. Basic testing involves 4 steps:

1. Set up the API connection
2. Create test data
3. Import test data via the API
4. Verify the import status

Set up the API connection

1. Log into the System Administration platform.
2. Navigate to System Administration > Data Transactions > API Management.
3. Click on > Create API Connection > enter an API Name.
4. Then find your API’s Client Secret and Client ID needed for API setup.

Create test data

1. Log into System Administration platform.
2. Navigate to Organizations.
3. Export Organizations - organizations.csv
4. Navigate to Terms
5. Export Terms - terms.csv
6. Make minor naming changes to data within organizations.csv and terms.csv.
   • For example, you could update a “orgName1” to include a prefix such as “API-Test orgName1”

Import test data via the API

1. Create a ZIP file of the updated organization.csv and terms.csv files
2. Import the zipped file via the API Integration you configured earlier.

Verify the import status

The API will provide a basic response indicating the status: In-Progress, Completed, or Failed.
If a file fails to upload, you can log into the System Administration platform and navigate to the Data Transaction tab to review specific file statuses and errors.

1. Use the /status endpoint to view the import status.
2. Login to System Administration | Data Transactions to view the import / integration status.
   • Confirm that all files have a "Completed Status" in the Data Transaction tab within System Administration.
3. Check Product Integration
   • Check the data within the System Administration and across any of your integrated products (Planning & Self-Study; Student Learning & Licensure) to confirm that the "test data" appears correctly.