In this lesson, you will review how to access your site's API documentation and information. This may be helpful to review before partnership and working with outside vendors, reviewing API expectations prior to any commitments.
District System Admins must contact Illuminate Support to request API credentials. For data privacy reasons, credentials will be communicated to admins, not vendors.
Where to Start
- To access your site's API information, enter your Illuminate site in your preferred Internet Browser.
- Enter or copy/paste the following after .com/live : ?ApiDocumentation
I don't have a '.com/live'. What do I do? Not to worry. You might have a '.com/dna', '.com/isi', or '.com/live' at the end of your web address. Either way, follow it with ?ApiDocumentation
Navigating Your API
This site can be provided to your vendor to assist with required data sets for SFTP and API access,
- General Information such as format, authentication, and additional information is available and a great starting place.
- The following areas can be selected to show all available fields:
- General
- Assessment
- Attendance
- Gradebook
Next Steps
Create a tile! Add this link as a customized tile in your dashboard. Learn how by visiting how to Customize Your Tile Dashboard!
Want to review who Illuminate already works with? Visit our Illuminate and Partners list to get started!