This is a deprecated version of the API Design & Implementation Guidelines published with Ed-Fi Data Standard v2.0. Implementers should refer to the latest version for current guidance.
Overview
This documentation provides design guidelines for an Ed-Fi representational state transfer (REST) application programming interface (API). These guidelines describe the properties to which an API specification and related implementation must adhere in order to be considered “aligned” to Ed-Fi technology standards. They are guidelines only. They do not describe a specific implementation or particular API specification. Where helpful, a rationale for specific guidelines is also provided.
An API implemented in accordance with the guidelines will have the following features:
- Supports high-throughput bulk as well as transactional data by using an optimistic concurrency model
- Protects resources with layered authentication and authorization models by using client tokens and user-level access strategies
- Complies with FERPA regulations regarding authorization to access resources
- Includes an open integration interface for identity management systems
- Includes documentation as part of the API itself
The following link is a PDF of the REST API Design & Implementation Guidelines documentation:
REST API Design & Implementation Guidelines
PDF files require the most current version of Adobe Reader to view. If you currently have a version earlier than 7.0 and are having difficulty viewing the file, consider downloading the latest version.
