Configure Connection
Members API for South Dakota guide
Request API access from the state, configure district credentials in NIM, and validate departments and the operations your district needs.
Before you beginDirect link to Before you begin
Your organization must request an API key from the state. Documentation is protected by login at the South Dakota MembersAPI portal. Ask the state to confirm the API access and connection credentials for your district.
NIM requires Hostname (a default is provided), School District, Username, and Password.
Obtain district accessDirect link to Obtain district access
- Contact the state to request an API key and access for your organization.
- Sign in to the MembersAPI portal to review the protected documentation and complete the state's setup requirements.
- Obtain the School District, Username, and Password values required for the NIM connection. Confirm whether the supplied default hostname is appropriate for your environment.
- Confirm the account's permissions for the intended student, educator, roster, and group operations. Review how supported changes affect downstream systems provisioned by the state.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a Members API for South Dakota system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Hostname | Use the provided default unless the state instructs you to use a different host. |
| School District | The district value supplied or confirmed by the state for API access. |
| Username | The username supplied for the district integration. |
| Password | The corresponding password for the integration. |
Test department retrievalDirect link to Test department retrieval
-
Select Test Connection. NIM attempts to retrieve departments using:
GET /api/Departments -
If the test fails, verify the Hostname, School District, Username, Password, network access, and state API authorization.
-
Collect the student, educator, roster, and group data needed by your process, and confirm that the expected district records are present.
-
Validate identity matching and relationship mappings. Test each intended provisioning, roster, or membership operation with safe records before enabling automation.
-
Confirm the effect of access changes in the downstream systems provisioned by the state.
The connection test checks department retrieval. Validate the other collections and intended write operations separately.