Configure Connection
Ed-Fi guide
Configure access to your provider's Ed-Fi API, test student retrieval, and validate the data needed for downstream user automation.
Before you beginDirect link to Before you begin
Ed-Fi is a data standard and framework implemented by multiple systems. API access setup varies by implementation. Contact the vendor or administrator responsible for your Ed-Fi environment for its access configuration instructions.
NIM requires Client ID, Client Secret, Token URI, and Tenant URL.
Obtain credentials and endpoint URLsDirect link to Obtain credentials and endpoint URLs
- Ask your provider to configure API access for NIM in the intended environment.
- Obtain the Client ID and Client Secret for that access.
- Obtain the Token URI used to request authentication tokens and the Tenant URL used as the API base URL. These URLs can differ between providers and environments.
- Confirm that the credentials can read students and the related collections required by your downstream automation.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add an Ed-Fi system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Client ID | The client identifier supplied for API access. |
| Client Secret | The secret associated with that client. |
| Token URI | The token endpoint supplied by your provider for the intended environment. |
| Tenant URL | The Ed-Fi API base URL supplied by your provider, including the base path required by that implementation. |
Test student retrievalDirect link to Test student retrieval
-
Select Test Connection. NIM attempts to retrieve a single student using the following path relative to the configured Tenant URL:
GET /students?offset=0&limit=1 -
If the test fails, check the credentials, Token URI, Tenant URL, network access, and student read permissions with your provider.
-
Collect the student and relationship collections needed by your process. Confirm that the expected records are visible to the API client.
-
Validate student matching and field mappings before using the collected data for downstream user automation.
The connection test checks student retrieval. Validate access to any other collections required by your process separately.