This is a working project for the Free Application for Federal Student Aid (FAFSA) API.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
data
server/php
swagger
LICENSE
README.md

README.md

Free Application for Federal Student Aid API

This is a working project for the Free Application for Federal Student Aid (FAFSA) API. This is NOT an official Department of Education project, but is born out of various government efforts to make this a reality.

The API WILL NOT directly submit to the Department of Education systems, but with enough momentum, eventually it will.

The goal is to establish an API for the FAFSA form, as well as numerous other API endpoints to support operations. There will be a central portal for support API operations, with the intent of developing an IRS modernized e-file system like platform, except more in line with modern approaches to API development--think TurboTax, but for education.

If you want to view the entire project work, and currently the official portal, visit http://ed-data.github.io/fafsa-api/index.html.

As of September 1st, 2015, this project is being revived. The goal is to launch:

This will be an API-first design project, completed by APIWare.io, with this README being the central project guide, and issue management will be handling the conversation around the project.

Current APIs being designed are:

If you'd like to get involved, you can email Kin Lane at info@apievangelist.com, or you can participate in the design and development through this Github repository. It will be an open project, allowing others to provide feedback on the direction the roadmap takes.

The project is looking for additional investors, so if there are features you'd like to see, specific APIs developed, please let us know. The more partners we bring to the table, the sooner we will have a commercially viable API platform, and the sooner we will be able to convince the Department of Education to integrate with the platform as well.

Setting Up the Project

Prerequisites

This project requires the following:

  • PHP (version 5.0.5+)
  • MySQL

For running the project on your own machine, you can use an installation package like WampServer (for Windows) or MAMP (for Mac) to install Apache, PHP, and MySQL all at once.

Running the API

  1. git clone https://github.com/ed-data/fafsa-api
  2. Create a MySQL database
  3. Run server/php/db/application.sql to create the necessary database tables
  4. Update server/php/config.php with the appropriate database server, database, username, and password

You can now access the API: http://localhost/fafsa-api/server/php/index.php/applications/?appid=0&appkey=0