For Developers

Troubleshooting Issues

Most common issues and solutions for the Illuminate Education provider.

Incorrect Authentication Method

Illuminate Education integrations support OAuth 2.0 for authentication. Ensure that OAuth 2.0 is configured correctly as it is the only supported method.

OAuth 2.0

Illuminate Education's OAuth 2.0 implementation uses the Authorization Code grant type. Ensure that the client ID, secret, and Illuminate URL are correctly configured in the Edlink platform.

  • Client ID & Secret:
    • client_id: abcdef1234567890
    • client_secret: 1234567890abcdef
  • Token URL:
    • https://demo.illuminateed.com/live/?OAuth2_AccessToken

For more details, refer to the Illuminate Education API documentation: Illuminate API Documentation

Data Handling Best Practices

Date Format

Use the SQL date format YYYY-MM-DD when passing dates as request parameters. This ensures compatibility and proper data retrieval.

Sites

Every school is represented as a "site." A district site serves as the parent entity for schools within the district.

Academic Years

Academic years are stored using the ending portion of the year. For example, the "2013-2014" school year is stored as academic year "2014."

Sessions

Each site has at least one session for a given academic year. Sites may have both "normal" and "summer" sessions.