Frequently Asked Questions
- Apigee Overview
- What is Apigee?
- Who is Apigee for?
- What problems can I solve with Apigee?
- Can I get a demo?
- How long does it take to set up?
- What does Apigee cost?
- How do I sign up for Apigee?
- How Apigee Works
- What types of APIs does Apigee support?
- How much traffic will my Apigee account support?
- Do I have to use an Apigee URL as my API endpoint?
- Does Apigee work with my existing API keys or existing security scheme?
- What are Apigee's availability levels?
Apigee Overview
Apigee is a free service from Sonoa the provides testing, debugging, analytics, and protection for APIs.
Apigee supports REST and SOAP APIs.
There is no software download needed for the client or server.
Apigee gives developers a platform to learn and debug their usage of APIs, and gives them visibility into the actual service levels of the APIs they consume.
Apigee enables providers to increase adoption of their API, understand API usage and performance, protect their service, and enforce API terms of use.
Apigee is in public beta – sign up here: http://app.apigee.com/sign_up.
Apigee is for:
- Developers who write web, mobile, or traditional applications that use APIs, as well as those who expose their service as an API
- Product Managers who provide APIs and need to understand their usage and performance
- Admins who support APIs and need to monitor performance and protect them from overload
- Learn about an API - Review an API's structure, experiment with the endpoint, and review the request and response messages. Share the messages with other developers to get their help with errors or demonstrate the behavior you saw.
- Debug calls to an API - Record messages you send to any API. Review requests and responses, dig into errors. Filter the recorded messages based on errors, headers, or client IP address.
- Understand API usage - drill into data on traffic, developers, data volumes, and error rates with an up-to-the minute dashboard. Enhanced support for analysis of Twitter API calls includes Tweet and Retweet counts.
- Protect your app - throttle API usage and protect against traffic spikes that can slow down your app or service. Enable rate limits of up to 50,000 messages per hour per API.
- Improve your customer experience – find out about API issues before customers do and make sure APIs are delivering to SLA.
Hop right in by using the API Console to experiment with the Twitter API, or sign up for a free Apigee account.
Apigee is self-service. The system will walk you through the short process of enrolling an API – no software download required and it takes about 60 seconds from start to finish.
Apigee's Basic service is free, and for users who need advanced capabilities we have Apigee Custom. We are committed to providing high-quality service to our Basic users and continue to expand the Apigee platform for free usage.
See Apigee pricing for more details.
Sign up takes less than a minute. You will have to confirm your email address - be sure to check your spam folder if you don't seem to receive it after a few minutes).
How Apigee Works
Apigee is for any Web API. It supports SOAP and REST (XML and JSON formats). Attachments are fine. Apigee also recently added support for encrypted API traffic (SSL).
For other complex API or custom policy needs, Sonoa has other on-demand and on-premise solutions.
Apigee also supports APIs that use OAuth, however there are a few nuances you should be aware of (using Twitter as an example):
- Do the OAuth dance with the canonical API endpoint (e.g. api.twitter.com).
- Once you have a user's token, use it to sign requests' base strings, which you would also build using the canonical endpoint from step 1.
- Then send those signed requests to your Apigee URL, such as twitter.myusername.apigee.com.
In this way traffic can flow to and from Twitter via your Apigee API using OAuth.
Apigee's free Basic service gives you up to 50,000 requests per hour per API. You can create as many proxies for as many APIs as you want. For example:
- if you are offering a single API you could support on average 100 developers at 500 requests an hour
- if you are using an API in a mashup you could support on average 500 app users making 100 requests an hour
If you set up an Apigee protection policy to drop messages beyond a specific limit then that's what Apigee will do. However, if you'd rather enjoy a cushion for occasional overages then Apigee will send you an alert instead.
The intent of these limits is to protect your app and make sure you don't get a huge bill for your back-end through intentional or unintentional overuse.
No, you can map your Apigee proxy URL, such as api-alohacrm.apigee.com, to your own domain, such api.alohacrm.com. To do so specify this mapping within the Apigee proxy setup and then add a CNAME record to your DNS settings (more info).
CNAME mappings do not currently support SSL traffic. If you require SSL and a custom domain, you have two options at this time, either:
- Set up your public endpoint with SSL on your domain (e.g. api.mydomain.com), and redirect all traffic to your Apigee endpoint, which should be directed back to a private endpoint on your servers. Your public endpoint will handle the SSL negotiation, though this will introduce extra latency.
- Alternatively, we are building support for SSL with custom domains into Apigee Premium. Contact premium@apigee.com for more information.
You can continue to use your existing API identity, authentication and authorization scheme with Apigee. If you currently use developer keys, you can use these with Apigee. Apigee does not currently provide API keys or require you to use API keys.
Our goal at Apigee is to deliver carrier grade levels of uptime for our API proxies, which means delivering every single API request you send, all the time. Apigee does not require proxy downtime for planned service or feature upgrades. We have had zero downtime since our launch in August 2009.
Apigee and Your Data
Apigee takes your privacy and security very seriously. You can read our commitment to protecting your privacy here. You always own your data and can access your data via API or download within a grace period if you cancel your account.
Apigee's core technology (Sonoa ServiceNet) is based on network-router architecture, and latency is on the same level that is introduced by other routers that your API call passes through. Note that Apigee is hosted on Amazon EC2, so if your app is also on Amazon EC2, your latency will be much less than this. Due to Amazon EC2's peering topology, we occasionally find that traffic to an API is faster when sent via Apigee than when sent directly.
Apigee's dashboard provides analytics on latency trends for your API, and Apigee's September release provides a tool for you to test the latency of your proxy during the sign-up process.
You can discontinue use of the Apigee proxy or cancel your account at anytime, and access your analytics data through an API or download (CSV). Because Apigee is a proxy, developers have to change the proxy URL's in their code or configuration, and API providers would make a DNS change.
About Apigee
Apigee's Basic service has a community forum and email support. We love our users and are in active beta, working to understand issues and continue to expand the service's capabilities.
Apigee is a service provided by Sonoa Systems. Sonoa provides industrial-strength API management and infrastructure to over 75 leading financial services, media, commerce and insurance companies. Apigee is built on the same core platform that as Sonoa's enterprise-class solutions, Sonoa ServiceNet.
We hope you'll keep in touch and give us feedback! You can subscribe to the Apigee blog or reach Apigee on Twitter. And you'll also notice a feedback tab hovering on the side of every page of Apigee for our community forums.

