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.

Contents

• Introduction
• Basics
• Authentication
• Authorization
• API Routes
• Date & DateTime Elements
• Descriptor References
• Resource Dependency Order
• Error Handling & Best Practices
• Using Code Generation to Create an SDK
• Using Scripting Languages to Connect
• Using the Online Documentation
• Using the Changed Record Queries
• Using the Sandbox Administration Portal
• More Information