API Umbrella Web provides the website frontend and web admin tool for the API Umbrella project. API Umbrella Web is a Ruby on Rails web application.
Please submit any issues to the primary API Umbrella issue tracker.
To get started, check out the getting started docs.
TODO: Finish documenting
Users can sign up for API keys through the front end, by visiting yourdomain.com/signup. They will be asked for the following information:
- First name (required)
- Last name (required)
- email (required)
- How will you use the APIs? (optional)
Users will also be required to agree with the site terms & conditions, as defined to your needs. No default terms and conditions are provided with API Umbrella.
Documentation is a work in progress, and can be found in multiple locations:
The admin section is where you can perform multiple tasks including:
- Configuring APIs
- Viewing analytics
- Setting up users and access control
- Publishing your changes
- Importing and exporting settings
API Umbrella is open sourced under the MIT license.
Geographic data comes from GeoLite data created by MaxMind.