API Client Developers' Guide

This documentation provides essential information for building client applications that interact with the Ed-Fi API, including generating an SDK from the API's OpenAPI specifications and considerations for developing a robust and scalable solution.

Contents

• Introduction
• Basics
• Resource IDs and Natural Keys
• API Routes
• Authentication
• Authorization
• Date and DateTime Elements
• Descriptor References
• Error Handling Best Practices
• Correlation IDs
• 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 Changed Record Queries