Program Notes

Questions

• Do we want API.Data.gov to serve as a replacement for API documentation on their sites?
• How do we get more developers involved in API Umbrella?
• What are the goals we'd have other developers involved in API Umbrella?

Documentation To Do

• Agency Best Practices (url structure, usage, ...)
• Be thinking about what long range agency adoption looks like (many APIs across diff. bureaus/offices)
• FAQ, including help questions

Agencies

• encourage use of own domain

Users

• can use key for any language

Other To Do?

• Memorialize team roles, team processes
• All helpdesk requests through GitHub Issues

Site URLs (aside from agency documents)

• http://api.data.gov/contact
• http://api.data.gov/about/
• http://api.data.gov/docs/
• http://api.data.gov/docs/api-key/
• https://api.data.gov/signup/
• http://api.data.gov/docs/rate-limits/
• http://api.data.gov/docs/errors/

Project Roadmap Notes

3 Month

• Complete the two primary requested features:
  • More granular admin permissions (prevent other admins from viewing other agencies data): https://github.com/NREL/api-umbrella/issues/9 (#56)
  • Programmatically manage API Keys (generation, block, revoke, etc): https://github.com/NREL/api-umbrella/issues/7 (??)
  • MyUSA (#72)
• Update the api.data.gov design to match the new Data.gov site. (mostly done but #43 still remains)

6 Month

• Scalability and security (#92, #70)
• Hackathon/training
• Figure out long-term hosting (#90)

12 Month

• GovX team project involvement
• Get others at GSA involved in the development
• Open source outreach

Other Possible New Features

• Easier query building interface for admin analytics: https://github.com/NREL/api-umbrella/issues/15
• Saved analytics reports: https://github.com/NREL/api-umbrella/issues/16
• Allow users to create an account where they can organize multiple API keys they’ve registered for and view analytics on their own keys.
• Explore how to better integrate the API key signup process with existing agency developer portals.
• Explore api.data.gov's interaction with geospatial services (from both GeoServer and ArcGIS).
• Expose an API for admins to access analytics data externally.
• Admin analytics should hide test monitoring traffic by default: https://github.com/NREL/api-umbrella/issues/8
• Download all results from an admin analytics query: https://github.com/NREL/api-umbrella/issues/14
• Restrict access by IP address: https://github.com/NREL/api-umbrella/issues/6
• Restrict access by HTTP referrer
• Notification of admins when their API is experiencing a traffic spike, errors, or users are exceeding their rate limits.

2014 Detail Goals

1. Feature Build Out

Need to represent more of this on a project roadmap to provide insight into this. Issue #91

2. Hardening

Issue #92 for coordinating this.

3. Replacing Self

Issue #90 for coordinating this.

4. Involvement with Team

This seems to be on track.