Configure Connection
MySchoolBucks guide
Arrange developer and district access, configure the NIM connection, and validate invoice creation for payment collection.
Before you beginDirect link to Before you begin
Follow the MySchoolBucks developer Getting Started guide. Create a developer account, then arrange the access it needs for your integration. MySchoolBucks Support may need to assist with completing this setup and authorizing district access.
NIM requires Hostname (a default is provided), District ID, Client ID, Client Secret, Username, and Password.
Create and authorize the accountDirect link to Create and authorize the account
- Use the vendor's developer portal to create a developer account.
- Arrange access for that account to the intended district and invoice functionality. Contact MySchoolBucks Support if assistance is needed to complete authorization.
- Obtain the district identifier, client credentials, and user credentials required by the NIM connection. Confirm the values with MySchoolBucks Support if the developer portal uses different credential names.
- Confirm whether the supplied default hostname matches the environment you will use, and store credentials securely.
Enter the connection settingsDirect link to Enter the connection settings
- In NIM Studio, open Systems > Overview and add a MySchoolBucks system, or select the existing system.
- Open Connection, enter the following settings, and save.
| NIM setting | Value |
|---|---|
| Hostname | Use the provided default unless MySchoolBucks instructs you to use a different host for the intended environment. |
| District ID | The identifier for the district the integration will access. |
| Client ID | The client identifier supplied for the authorized integration. |
| Client Secret | The secret associated with that client. |
| Username | The username supplied for the account authorized to access the district. |
| Password | The corresponding password for that account. |
Test district retrievalDirect link to Test district retrieval
-
Select Test Connection. NIM calls the following path to retrieve districts:
GET /v1/districts -
If the test fails, verify the Hostname, District ID, client credentials, user credentials, network access, and account authorization with MySchoolBucks Support.
-
Collect the reference data required for your invoice process and confirm the intended district records are available.
-
Validate invoice field mappings and test invoice creation in an approved test environment before enabling production automation.
The connection test checks district retrieval. Validate invoice creation permissions and the resulting invoice separately.