Illuminate: How To Create API Access Keys

SchoolMint has been granted API access as an API consumer across all of Illuminate systems, provided the district sets up an access key.

 Create API Access keys:

1. Create a user account for SchoolMint with access to the appropriate sites and terms in Admin > User Management
2. Once the user account is created, you will need to set up that user with an API key
3. To setup, an API key go to Admin > Other > API Management
4. First, click Manage Access Keys and do a quick search for "SchoolMint" to ensure a key has not already been set up.
5. If a key has been set up, click on the details for the consumer and make note of the access key and access secret
6. If not, click on Add New Access Key and set up a new key. Select SchoolMint as the consumer, Accessor type should be "user", then find the user that you recently set up.
7. Finally, make sure to click on Manage API Consumers and find "SchoolMInt" in the list - make note of the consumer key and consumer secret.
8. Once this setup is done in your Production instance, request a copy of this to your Sandbox instance and share the details with SchoolMint team.
9. As the last step, it would be good to share with SchoolMint team, the following tables/data/codes from your Illuminate instance, so we can make sure we have the correct info that is being collected in SchoolMint and the same can be transferred back to your Illuminate instance.

• Genders - id,  code, value
• Birth Date Verification methods - id,  code, value
• Disabilities - id,  code, value
• Special needs - id,  code, value
• Accommodations 504 statuses - id,  code, value
• Dwelling types - id,  code, value
• Graduation Statuses - id,  code, value
• Exit codes - code, description
• Grades - grade level, value, grade key, grade code
• Health Cautions - caution id, value
• Hearing Loss - hearing loss id, value
• Housings - code, value
• Language Fluency - code, value
• Languages - code id, value
• Parent guardian highest education levels - level id, value, legacy education code
• Races - code id, value, race key
• Site type - type id, value
• States - state code, value
• Countries - code, value
• Contact types - code, value, type_key
• Student programs - program code, program

--------------------------------------------------------------------------

Still have questions? Email us at [e-mail].