How do I add a managed data connection via Ed-Fi API as a Mastery Connect admin?
As an admin, you can configure a data export connection in your Mastery Connect account. Mastery Connect supports data connections using Secure File Transfer Protocol (SFTP) and via Ed-Fi v2.5.0.
Before you can configure a data export using the Ed-Fi API, you must have the following information:
- Export endpoint URL
- API Key
- API Secret Key
You can verify the connection before adding it to your account. You can also manage existing data connections.
Open Admin
In the Global Navigation menu, click the Admin drop-down menu [1]. Then, select the Manage option [2].
Open Data Exports
In the Manage list, click the Data Exports link.
Open Data Export Connections
In the Data Export page, click the Connections tab.
Add Connection
Click the Add Connection button [1].
Note: The My Downloads tab displays by default. If do not have any configured any data connections, click the Connections tab to add a connection [2].
Enter Connection Details
In the New Connection window Connection section, enter a name for the connection in the Name field [1]. Then click the Type drop-down menu [2] and select the API option [3].
Note: You can also select to configure an SFTP connection.
Enter Settings Details
In the Settings section, enter the API configuration details, including the connection URL, API key, and API secret key [1].
The supported API format displays in the Format drop-down menu [2]. Mastery Connect supports Ed-Fi API v2.5.0.
To select the student reference source, click the Student Reference drop-down menu [3]. You can select Student Number or State Number.
Test Connection
To validate the server connection, click the Test Connection button.
View Connection Notification
If the test connection fails, a Connection Failure notification displays [1]. Additionally, a Bad Connection icon displays [2].