Program Notes

Links

• Project Site
• Project Site - About Page
• Project Site - Metrics Page
• Admin Login Page
• Project contact address: api.data.gov@gsa.gov
• Project Site for the Underlying Engine
• Code Base for the Underlying Engine
• Code Base for the Project Site

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
• dummy key
• embedding the api key form

Users

• can use key for any language
• dummy key

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/developer/
• 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/

To update this site, make pull requests to the master branch of this repo.

Project Roadmap Notes

3 Month (10/1/14)

• 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 (1/1/14)

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

12 Month (7/1/15)

• 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.

=======================

• Do you have access to this private repo? https://github.com/18F/api.data.gov-ops If not, we'll need to get you access. This contains all our Cloud Formation and Chef stuff, along with more documentation on running our systems.
• If Gray hasn't already added you, we'll want to add you to the api.data.gov@gsa.gov e-mail distribution list.
• Code base: https://github.com/NREL/api-umbrella * Lua-based proxy code: https://github.com/NREL/api-umbrella/tree/master/src/api-umbrella/proxy * Rails admin APIs app: https://github.com/NREL/api-umbrella/tree/master/src/api-umbrella/web-app * Ember.js Admin UI: Currently here (embedded inside the Rails app): https://github.com/NREL/api-umbrella/tree/master/src/api-umbrella/web-app/app/assets/javascripts/admin However, the Rails and Ember upgrade I'm working on has shifted the location here (it's a standalone Ember.js app): https://github.com/NREL/api-umbrella/tree/admin-and-rails-upgrade/src/api-umbrella/admin-ui I'm hoping to merge those upgrades into master sometime soonish, so hopefully this will be a bit cleaner soon.
• I'll get you push access to the NREL/api-umbrella repo.
• High-level architecture: https://api-umbrella.readthedocs.io/en/latest/developer/architecture.html
• Development setup using Vagrant: https://api-umbrella.readthedocs.io/en/latest/developer/dev-setup.html