Technology Providers - Implementation

• Ed-Fi API Integration Architecture for Data Providers
• Getting Started with APIs
  • All Providers
    • All Providers - Activity 1
• Ed-Fi API Fundamentals
  • Enumerations (Descriptors)
  • API Key Structures
  • Authentication and OAuth
  • Authorization
  • API Extensions
• Technology Partner - Implementation
  • Best Practices - API Integration
  • Invest in a Strong UX
  • Support Multiple Versions
  • Support User Configuration of Identifiers
  • Support Data Selection
  • Error Handling
  • Implement Data Reconciliation
• Common Integration Challenges

API Client Developers' Guide

This documentation provides essential information for building client applications that interact with an Ed-Fi ODS / API platform. It includes instructions on generating SDKs with Swagger Tools and considerations for developing a robust and scalable solution.

• Introduction
• Basics
• API Routes
• Authentication
• Authorization
• Date and DateTime Elements
• Descriptor References
• Error Handling Best Practices
• Error Response Knowledge Base
• Improve Paging Performance on Large API Resources
• Improve Paging Performance with Partitioned Cursor Paging
• Resource Dependency Order
• Using Code Generation To Create an SDK
• Using the Online Documentation
• Using the Sandbox Administration Portal
• Using the Changed Record Queries