For Developers

About Onboardings

Edlink Dashboard Onboarding Options

The Edlink Dashboard provides a UI for connecting districts and universities to your application. School integrations appear as "requested" until you approve them as "active," at which point data flows and billing begins.

Important: Developers cannot query data or verify the connection via the API until the integration status is changed from 'Requested' to 'Active'. Even if a source sync is successful, you will not be able to see the data via the API until the integration is activated.

Three Onboarding Options:

  1. Generic Integration Link
    • Simplest approach using same link for all schools
    • Pros: Easy to use, doesn't expire, can include in documentation
    • Cons: Less secure, difficult to correlate with schools in your platform, may require manual configuration
    • Schools may connect any of your accepted data sources
  2. Unique Integration Link
    • Secure approach with school-specific links
    • Pros: More secure, easier correlation to schools, can pre-select allowed data sources
    • Cons: Requires generating unique links, may need manual configuration
    • Links expire after 30 days
  3. API-Initiated Onboarding
    • Most flexible and customizable approach
    • Pros: Can be initiated from your UI, allows data source pre-selection, supports custom redirects, enables reliable school correlation, reduces manual configuration
    • Cons: Requires more development effort
    • Links expire after 3 days

Contact your Edlink client success manager for assistance with school onboarding if needed.