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