New User Setup: Accounts and Tools

Prior to onboarding and to be considered for the next school year, New Vendors must submit a Vendor Profile between July 1st and October 31st to be best prepared for the following school year.

Steps to Get Started with WISEdata Ed-Fi Sandbox/User Acceptance Test:

1. Obtain User Account, API Credentials, and Permissions

Do not use a shared email address but one that is specific to you and associated to your organization.

Before starting with WISEdata Ed-Fi Integration, follow these steps:

Evaluate Your Current Vendor Status

If you have previously tested in the WISEdata UAT sandbox, proceed to “Obtain OAuth credentials”.
- If you are new to WISEdata Ed-Fi, proceed to “Obtain a MyWisconsin ID Account (UAT)”.

Obtain a MyWisconsin IDAccount (UAT)

Access to WISE applications requires either a Google Workspace or MyWisconsin ID. Follow the self-registration process on the Wisconsin Access Management System (UAT) site https://uaon.wisconsin.gov/WAMS/home or work with your local IT for a Google Workspace account.
Use your newly created account to access WISEhome (UAT)

Request Ed-Fi Credential Application Permissions

After you obtain a user ID/Username and have successfully logged into WISEhome (UAT), fill out this Vendor Access & Inquiry form:
- Inquiry Type: “Request Access UAT Environment (Sandbox)”
- Company - Product: Non-Certified Vendor
- In the “Additional Details” section, include your user ID/Username, email, and type of access (Admin vs Read-only). Example:
  Additional Details:
  email address
  Admin access

Obtain OAuth credentials

The Ed-Fi API is a service secured via OAuth 2.0. OAuth credentials (keys and secrets) will be generated by DPI upon request and are needed to make REST calls.

If you have an existing test education agency in the sandbox environment, you can continue using it.
- If its a new school year or you need another education agency, submit a https://dpi.wi.gov/wisedata/vendors/vendor-access-inquiry form.
  Note that new education agencies will not have any data initially.

Access your API credentials

Log into the Ed-Fi Credential Application with your user ID/Username and password to find your credentials, education agency ID, school IDs and interactive reports.

2. Authentication & Authorization

Authentication

To make REST calls to the Ed-Fi API, a REST client is required. The client that will publish data to the Ed-Fi API should be the Vendor software. The Vendor implementation will likely be based on the Ed-Fi REST client.
- For testing, you can use Swagger UI [Check Ed-Fi Credential app, Profile menu]
- To authenticate via native code, use the Authentication URL [Check Ed-Fi Credential app, Profile menu]
Connect Using a client Key and Secret
- With your user ID/Username and password to access the Ed-Fi Credential application UAT ‘sandbox’ environment [https://uawisedata.dpi.wi.gov/EdFiCredential/]
- The Ed-Fi Credential application is your source for your API credentials (keys and secrets) for all education agencies that subscribe to you as a vendor. In the UAT environment, DPI creates these subscriptions for you. In Production, you will receive an email notification when an education agency subscribes to your product.

NOTE: The URL and login credentials for the Ed-Fi Credential application will differ between Production and UAT ‘sandbox’. You will need to obtain a user account, MyWisconsin ID, for the production environment [MyWisconsin ID (PROD)], then complete out the Vendor Access & Inquiry form.

Select: Inquiry Type: Request Access to Ed-Fi Credential Application - Production Environment and
Additional Details: Include access type Vendor (For development team) or Support (For Customer Service)

NOTE: The URL and your log-in credentials for the Ed-Fi Credential application will be different in Production than UAT ‘sandbox’. You will have to Obtain a MyWisconsin ID for the production environment [MyWisconsin ID (PROD)], then submit the Vendor Access & Inquiry form.

To better understand ‘authentication’, read this first: https://techdocs.ed-fi.org/display/ODSAPIS3V520/Authentication

Authorization

The Ed-Fi API uses the API credentials to authorize requests. With each request made to the API, the token is obtained from the authentication process. The Ed-Fi API uses this token to identify the caller and determine the permissions that apply to each of the accessible API resources.
The API credentials are tied to a claim set. Wisconsin DPI restricts resources in the Ed-Fi API by linking the vendor's API key to a claim set.
The API credentials (key and secret) are tied to an education agency. For many resources/endpoints, a relationship-based strategy will be used. For example, a SIS vendor will be provided with an API key that is associated with a specific education agency.
For more information about Ed-Fi OAuth 2 authorization see: https://techdocs.ed-fi.org/display/ODSAPIS3V520/Authorization

3. Get familiar with the development and testing tools

For more information see the Software Testing Resources and Development Resources

REST client which can authenticate via OAuth 2
Swagger is not only a source of documentation but can be used to monitor and manage UAT API transactions
Web traffic tracer/debugger. REST clients (SoapUI or RestClient2) will show web traffic when you make a request. The web debuggers can be useful when creating requests.
Deleting data from your UAT sandbox. To use the Data Clean-up tool, follow these instructions.
Sometimes you need to clear data and re-publish during testing. The WISEdata team has integrated a cleanup tool into the Ed-Fi Credential application. This Data Clean-up tool enables vendors to delete data for a specific education agency in the sandbox.
Troubleshooting. If you are receiving API errors, check the Ed-Fi Tech Docs>Ed-Fi ODS-API Error Responses for common API errors and resolutions.