Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions pages/api_highlights.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,13 @@ authors: "Gray Brooks"
---
## Government API Milestones and Great Examples

* **ADLNET API Program** - The API-based education program based out of DOD serves a model for all agencies with their work in [communicating with the public about their API development](https://pages.18f.gov/API-All-the-X/pages/government_api_blogposts#adlnet). Few programs can rival the depth and conviviality with which these API producers blog about the design, technology, implementation, and use cases of their APIs.
* **ADLNET API Program** - The API-based education program based out of DOD serves as a model for all agencies with their work in [communicating with the public about their API development](https://pages.18f.gov/API-All-the-X/pages/government_api_blogposts#adlnet). Few programs can rival the depth and conviviality with which these API producers blog about the design, technology, implementation, and use cases of their APIs.
* **BroadbandMap.gov** - The team behind [BroadbandMap.gov](http://www.broadbandmap.gov) adopted a true API-first model - beginning by building out [a powerful suite of APIs](http://www.broadbandmap.gov/developer) and *then* building the website on top of their own APIs. This is the model for all projects to adopt.
* **Census Bureau** - The Census Bureau's [API program](http://www.census.gov/developers/) is notable for its solid incorporation of best practices. The team took the time to design a clean, comprehensive API that addressed real user needs, while still offering bulk data, a developer mailing list, ease of registration, and an app gallery. Furthermore, they continue to iterate and grow the available data calls based on analytics and [real user feedback](http://apiforum.ideascale.com/).
* **Consumer Financial Protection Bureau** - CFPB's top-class [API documentation](http://cfpb.github.io/api/hmda/) not only serves their developers well, but is also opensourced in such a way that [other agencies have been able to quickly repurpose and put it to use](https://pages.18f.gov/open-source-program/pages/case_study/CFPB_open_source_documentation).
* **Department of Health and Human Services** - The [data hub of HHS](http://healthdata.gov/developer) includes one of the most solid examples of developer outreach in the Federal government. In addition to making the disparate APIs from across the department [more easily findable](http://healthdata.gov/dataset/search/?f[0]=sm_ckan_media_format%3AAPI), HealthData.gov maintains a well-rounded developer experience, with plenty of developer-targeted [blogging](http://healthdata.gov/developer) and [ideation](http://healthdata.gov/ideas).
* **Department of Labor** - The Department of Labor maintains [a single, integrated API program department-wide](http://developer.dol.gov). By offering a clean, consistent endpoint to developers, Labor is able to then also provide more robust set of developer resources - including SDKs, code samples, FAQ, api key generation, and feedback forums.
* **DigitalGov Search API** - One of the most successful shared services in government, the DigitalGov Search product can be easily added to any site with a quick code snippet or can be integrated on a more sophisticated fashions using [its search API](http://search.digitalgov.gov/developer/index.html). In addition, they have built and opensourced powerful APIs around USAJOBS and product recall data for better integration into site search but also so that anyone else can benefit from them.
* **Department of Labor** - The Department of Labor maintains [a single, integrated API program department-wide](http://developer.dol.gov). By offering a clean, consistent endpoint to developers, Labor is able to then also provide a more robust set of developer resources - including SDKs, code samples, FAQ, api key generation, and feedback forums.
* **DigitalGov Search API** - One of the most successful shared services in government, the DigitalGov Search product can be easily added to any site with a quick code snippet or can be integrated on a more sophisticated fashion using [its search API](http://search.digitalgov.gov/developer/index.html). In addition, they have built and opensourced powerful APIs around USAJOBS and product recall data for better integration into site search but also so that anyone else can benefit from them.
* **Federal Register** - In addition to offering [a reliable API to a fundamental dataset](https://www.federalregister.gov/blog/learn/developers), the Federal Register also makes a point to consume the [Regulations.gov API](http://www.regulations.gov/#!developers) in FederalRegister.gov, [creating a mashup](https://www.federalregister.gov/blog/2012/04/in-synch-with-regulations-gov) that provides a better user experience.
* **Federal Register Write API** - The Federalregister.gov site’s new comment web form, uses the new Regulations.gov write API. The form is enabled once the user clicks the green “ Submit a Formal Comment” button. The new web form via the API allows the public to submit comments directly into FDMS.gov, for agency review and posting on Regulations.gov. It can be seen in action [here](https://www.federalregister.gov/articles/2014/06/18/2014-13726/carbon-pollution-emission-guidelines-for-existing-stationary-sources-electric-utility-generating).
* **Food and Drug Administration** - The [open.fda.gov](http://open.fda.gov) program is a model API project for government on numerous fronts:
Expand All @@ -22,7 +22,7 @@ authors: "Gray Brooks"
- Strong development process - OpenFDA built in time to provide a private beta and incorporate [API usability testing](https://pages.18f.gov/API-Usability-Testing/) before going live. This allowed them to catch and fix things that would have hampered their rollout and taken longer and caused more trouble to fix after developers were already using the API. A strong and intentional pre-release program.
- Continued growth - The program continues to iterate, [improving its documentation](https://github.com/FDA/open.fda.gov/issues?q=is%3Aclosed) and [adding new](https://groups.google.com/d/msg/us-government-apis/K5B8DeMxmR8/Q-Pa41IF4eMJ) [endpoints](https://groups.google.com/forum/?nomobile=true#!topic/us-government-apis/Dp8zDWZqtUs).
- Solid terms of service - The team at FDA put a lot of [solid](https://github.com/GSA/API-Resources/issues/1) [work](https://github.com/GSA/API-Resources/pull/11/files) into building a much more usable, developer-friendly terms of service. This good work is helping their strong growth with developers.
- Well-rounded develper experience - The developer hub has pretty much [all of the major components that developers want and need](https://pages.18f.gov/API-All-the-X/pages/developer_hub_kit). This thoroughness makes a difference in developer adoption.
- Well-rounded developer experience - The developer hub has pretty much [all of the major components that developers want and need](https://pages.18f.gov/API-All-the-X/pages/developer_hub_kit). This thoroughness makes a difference in developer adoption.
* **National Renewable Energy Laboratory** - NREL's [API program](http://developer.nrel.gov/) did not just content itself with building out a number of well-designed APIs, they went the further mile to [open source the underlying stack](https://github.com/NREL/api-umbrella) and, in coordination with GSA, offer the components as a [powerful shared service](http://api.data.gov).

*[And more...](https://github.com/18F/API-All-the-X/issues/157)*
Expand Down
2 changes: 1 addition & 1 deletion pages/casestudy_social_media_registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ And, as I explained above, there are APIs for developers to access the entire li

Personally, I think the idea to allow anyone with a .mil or .gov email address to verify accounts is one of the most remarkable things about the registry. Dozens of public servants have already registered hundreds of social media accounts that otherwise would have taken many hours to seek out and gather.

While I’m sure the list of accounts in the registry is not perfectly comprehensive, it’s much more comprehensive that any individual or small team of people could make it.
While I’m sure the list of accounts in the registry is not perfectly comprehensive, it’s much more comprehensive than any individual or small team of people could make it.

This approach allows us the benefits of crowdsourcing with the added benefit of knowing that every participant has been vetted and trusted with an official government email address. We call it fedsourcing, and I hope to see the method used in other inter-agency information gathering applications.

Expand Down