This first section presents the basic information to allow you to interact with the Ed-Fi API and get some early data flowing in a development setup.

Architecture - Student Equity-VDG

Describes the various parts of the starter kit, including the role your application plays.

Data Requirements - Student Equity-VDG

Describes the data elements provided by your product. Later sections will describe the formats and processes by which that data is transmitted to the Chronic Absenteeism Starter Kit.

Understanding REST APIs - Student Equity-VDG

If you are new to REST APIs, this section provides some background material to help you understand this system integration pattern.

Authentication - Student Equity-VDG

This section describes how your software authenticates with the API.

Authorization - Student Equity-VDG

This section describes how requests to the API are authorized: how does the API determine if your system is authorized to read and write various data elements.

Online API Documentation and Sandbox - Student Equity-VDG

The Ed-Fi Alliance maintains online Swagger documentation that is very useful as a reference and early exploration tool.

Maintenance and Version Dependencies - Student Equity-VDG

Information on the version requirements for the Starter Kit and where to receive updated information on maintenance over time.

Sample Transactions - Student Equity-VDG

A few examples of what real-world transactions might look like.

Browser not supported