ED-API-Program

An API program for the Department of Education, based on the 18F service.

Project Overview - outline

• Launch an API capacity for the agency - tasks
• Build a revamped developer hub for the agency - tasks
• Train agency staff to use the API capacity - tasks
• Coordinate on a complete rollout for dataset - tasks
• Enable the agency to internatize the entire program - tasks
• General implementation - tasks
• Developer engagement - tasks
• Encourage open source at the agency - tasks
• Administrative work - tasks

Deliverables

Direct links to deliverables will be added as they become available.

• Project Timeline
• API rollout plan
• Developer engagement plan
• Hosted autoapi
• Successfully launched API
  • API documentation for said API
• ed.gov/developers proposal
  • API Feedback Engine
• Guidance on setting up monitoring
• Documentation for transitioning the API
• Other resources:
  • Template API standards
  • Sample API requirements
  • General agency checklist
  • General agency strategy - how to get started with APIs
  • API Strategy for ED
  • API primer for contracting officers
  • Guide to ensuring discoverability
  • Proposal for an MVP of a developer hub without APIs
  • Developer Hub Notes
  • Template GitHub Guidance
  • Guide to Setting Up GitHub at your Agency
  • A hosted secure credentials messaging service
  • API deprecation plan
  • AutoAPI test plan