Configure Connection
Vanco ASAP guide
Arrange API access, configure the Vanco ASAP connection in NIM, and validate student data for downstream user provisioning.
Before you beginDirect link to Before you begin
Contact Vanco ASAP Support to provision API access. Review the Vanco ASAP API documentation for the vendor's requirements.
NIM requires Hostname, Org ID, API Key, Username, and Password.
Obtain credentials and organization detailsDirect link to Obtain credentials and organization details
- Ask Vanco ASAP Support to provision access for the data your downstream process requires.
- Obtain the API hostname, organization identifier, API key, and account credentials for the intended environment.
- Confirm access to students and any other collections required by your process, and store credentials securely.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a Vanco ASAP system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Hostname | The Vanco ASAP API host for your environment, using the format expected by the Connection screen. |
| Org ID | The organization identifier supplied for API access. |
| API Key | The API key provisioned for your integration. |
| Username | The username of the account authorized for API access. |
| Password | The corresponding password for that account. |
Test student retrievalDirect link to Test student retrieval
-
Select Test Connection. NIM attempts to retrieve students using:
GET /api/Students -
If the test fails, verify the Hostname, Org ID, API Key, account credentials, network access, and API permissions with Vanco ASAP Support.
-
Collect the student and related data required by your process, and confirm the expected records are present.
-
Validate identity matching and field mappings before using the collected data for downstream user provisioning.
The connection test checks student retrieval. Validate other collections required by your process separately.