API Best Practices Blog
Apigee v2 Console: Making learning APIs as simple as possible, but no simpler »
The most delightful learning experiences are natural and effortless. With that in mind, we at Apigee strive to minimize the time it takes to make your first successful API request.
We make it as simple as possible to learn how to make successful API calls, but don’t prevent you from purposefully making failing requests, which can be useful while troubleshooting. Read on!
In the v2 Console, there are three new features that make it simple for you to learn an API.
Contextual Help
Let’s face it, nobody likes documentation until they get stuck and then, only as much as they need to get their work done. For a long time, people have asked us for deep-linked documentation right in the console. API Providers can now add summaries and deep-links to every method and parameter in the Console and API Resource pages.
In many cases, you have all you need to know to make a successful API request right in the Console but if that’s not enough, you can go directly to the full documentation at the API provider’s site.
Parameter Surfacing
Even the best APIs can be complex to learn. We’ve made it even easier to make a successful API request by surfacing all of the parameters in an intuitive way. In most cases, you can choose an API provider (1), select the service (base URI) (2), and method (4) you want to work with and send the request.
You’ll see right away if the method requires authentication (3) or parameters (5) and you can add those as well.
You are alerted if you are missing any of the required parameters as shown below.
All of the parameters defined in the API should automatically be listed in the appropriate query tab including:
Query parameters: In this query the alt parameter is set to ‘atom’.
In this case, the API specifies that this must be one of 5 types and all are shown in a drop-down menu. This would show up in the request as
http://gdata.youtube.com/feeds/api/users/apigee?alt=atom&prettyprint=true&v=2
where alt=atom is a drop down and prettyprint=true is a Boolean value in the Query tab.
You can additionally add any custom name/value pairs to the query of the API request.
Template parameters: are associated with parameters in the URI path. In the example above, {username} is a template parameter and can be provided in the Template tab.
This is a required field as noted by the asterisk. You can additionally add any custom name/value pairs to the query of the API request.
Header parameters: are your chance to modify the headers of the request. user-agent is a very common choice and we’ve provided it for you so, for example, you can simulate sending the request from an iPhone or Android device.
You can additionally add any custom name/value pairs to the Header of the API request.
Body parameters: are typically for an attachment like uploading a video or picture or an XML, or JSON payload.
While we’ve made it easy to make successful API requests, we don’t prevent you from purposefully making failed requests. These are often helpful in isolating problems. As simple as possible, and no simpler!
Bookmarking API Requests
Another new feature of the v2 Console is the ability to bookmark API requests complete with the method and every parameter. This allows you to to repeat a range of test cases or share a particular API query in a blog.
For example, say I wanted to instruct you on the Youtube /feeds/api/users method. I could simply provide a link and it would load the console ready to make the request. Go on, try it.
As you can see, this will give you a list of great Apigee videos in atom format. This can also be used by API providers to make it easy for developers to instantly try examples from their reference documentation, on discussion boards, or email threads.
These are just a few of the great features included in the new v2 Console. With over 60 API providers, there are a lot to choose from.
If you would like a Console for an API that you don’t see, please send an email to .(JavaScript must be enabled to view this email address). You can use the Generic/Other console which allows you to send any REST request.
New Release - API Developer Tools »
I'm delighted to announce that a new release of our Developer Tools. Actually, we've been plugging away on releases on a monthly basis for the last 6 months and now it has really come together. Seriously, there are some huge changes. A short summary is provided below.
The console speaks for itself. We have indeed been "working" and below the picture are the release highlights.
All new features!
- All Resources are surfaced to the user along with indication of which require authentication and deep-links to the API Provider's doc. All of this is generated from the WADL. This is a great step for both API providers wishing to make their own To-Go Console and for Developers.
- We automatically surface all of the parameters for every resource through the GUI along with parameter-level docs with links if we have them.
- Users can set the user-agent for requests.
- Support for WADLs with multiple end points in the same Console. Better for providers and easier developers to use.
For example:
api.twitter.com
search.twitter.com
statuses/{id}/retweeted_by,
{id}
is a template param.
- Bookmark Console requests. Yes, you can save all the settings and parameters to make a request.
For example, say I wanted to instruct you on the Youtube /feeds/api/users method.
I could simply provide a link and it would load the console ready to make the request. Go on, try it!
As you can see, this will give you a list of great Apigee videos in atom format.
This can also be used by API providers to make it easy for developers to instantly try examples from their reference documentation, on discussion boards, or email threads.
- Compression of WADLs to improve page load time. We are going to be working quite a bit more on performance.
We also included a large number of upgrades and bug fixes:
- Upgrades to Providers page; improved navigation and more.
- Bug fixes: hundreds over the last few months.
- V2 Console Migration
- All but one of our Consoles has been moved to our v2 platform!
- New! v2 Support following authentication schemes: HTTP Basic Auth, Custom Token, Two-legged OAuth, and OAuth refresh token.
- Resolved Google Authentication issues enabling all of the Google Consoles
- 5 Refreshed Consoles
Consoles
As of this writing, we have 62 Consoles. You can see the full list of API Providers in HTML or use our Console API.
Have a desire to see an API included that we don't have? Send requests to .(JavaScript must be enabled to view this email address).
New Consoles
BlueVia
BoxCar
Context.io
DonorsChoose.org
Echonest
Facebook (added the Search endpoint)
Foursquare
Google AdSense (Management)
Google Analytics
Google Books
Google Calendar
Google Latitude
Google Mail (Settings)
Google Sites
Google Spreadsheets
Google Tasks
Milo
MusicBrainz
Myspace
Orkut
Picasa
Rdio
Rhapsody
Sendgrid
Spotify
Tumblr
Updated Consoles. APIs are best served fresh!TM
Urban Airship
Usergrid
Weather Underground
Yahoo Weather
YouTube
Tumblr
APIs We Love: DonorsChoose.org’s New API Console »
Today there are thousands of APIs doing amazing things - revolutionizing personal data, exposing powerful cloud services, and transforming the way businesses work. We particularly love APIs that make the world a better place - like the API for DonorsChoose.org, an online charity that makes it easy for anyone to help students and classroom projects in need. We're excited to announce that you can learn, explore and test the DonorsChoose.org API on our Providers Page (now with over 40 APIs!) or in the DonorsChoose.org developer guide. DonorsChoose.org uses Apigee To-Go to embed the API Console in their site.
The DonorsChoose.org API lets developers help classrooms right from their websites or apps. It has been used by Chevron, SONIC Drive-In, NBC Universal, Starbucks and others to build customized cause marketing and community engagement. Now you can use the Apigee API Console to get started quickly, exploring project listings and integrating donation functionality right into your apps.
Tell us your app plans, send feedback and let us know additional API Consoles you'd like to see - email us at .(JavaScript must be enabled to view this email address).
8 New API Consoles: Music and Weather APIs, with Spotify, Weather Underground, Rdio and More »
We've been adding a bunch of new API Consoles lately, and today we're excited to add a few more to the list! Come play with eight new API Consoles, with a special focus on APIs for music and weather. Make apps that can rock and roll with some of the top music APIs: Rdio, Spotify, Echonest and Rhapsody. Get weather data with Weather Underground and Yahoo Weather. We've also rolled out an API Console for Donors Choose - an amazing online charity that lets users donate to classrooms in need. And to expand on our list of social API Consoles, including Facebook, Twitter and Chatter, we've added the MySpace API.
Easily see the full surface area of the API, send and view request / response pairs, get past authentication quickly and drill into errors with these APIs and over 40 total on our API Providers page:
Rdio: Easily, legally access and play music across web and mobile.
Spotify: Explore Spotify's music catalog.
Echonest: Gain access to billions of data points about music.
Rhapsody: Access Rhapsody technologies and content, including metadata, search and music player.
MySpace: Create apps and games within the MySpace platform.
Donors Choose: Help classroom projects by integrating donation functionality.
Weather Underground: Integrate weather data into your app.
Yahoo Weather: Up-to-date weather information, including condition codes.
Got an API you want to see on Apigee? Email us at .(JavaScript must be enabled to view this email address).
9 New API Consoles: Stuff Geeks Love for Your Holiday Hacking »
Our holiday gift to you: nine brand-new API Consoles to assist and inspire you in your holiday hacking. Apigee API Consoles make it easier to learn, test and explore APIs by letting you view request/response pairs, get past authentication quickly and find problems faster. We've hand-picked nine of our favorite APIs on the cutting edge: from APIs that help you predict the future, solve your coding questions, track your quantified self, or harness facial recognition technology, there's something here for every geek.
You can check out all 30+ of the APIs we support, including Twitter, Facebook, Instagram and LinkedIn, on the API Providers page. Here's a sneak peek at the new ones:
Freebase: Read and write access to the Freebase graph of people, places and things.
PageSpeed: Integrate PageSpeed performance analysis into your development workflow.
Ruby Gems: Interact with RubyGems.org to query and create gems, mange owners and more.**
** (Thanks to Sebastian Spier, who first built out the Ruby Gems Console on his blog - check it out! Thanks Sebastian.)
Face.com: Build applications with facial recognition capability.
Stack Exchange: Create apps or scripts that can access Stack Exchange questions, answers, comments, badges and more.
Google Prediction: Harness Google's cloud-based machine learning tools to analyze your data.
Google Web Fonts: Include high-quality web fonts in any web page.
Pivotal Tracker: Access and manipulate agile project management data including projects, stories and tasks.
Fitbit: Bring Fitbit health data into your apps, including user activities, sleep, heart, glucose and blood pressure information.
Let us know what you think, and other APIs you want to see. Email us at .(JavaScript must be enabled to view this email address).
Updates to the API Console: Get to the APIs You Want Faster, Beta Test v2 »
Apigee API Consoles help you learn, explore and test the APIs you love. We've been listening to your feedback, and we've got a few updates that make it easier to find the APIs you want to use with a new Providers page, explore what they've got to offer with a new API Resources page, and start playing sooner with an updated beta of the "v2" API Console, currently available for Twitter. Check out details below!
New Providers Page
It's now much easier to navigate to the APIs you want to use with our Providers page, which shows all the APIs we support and lets you quickly get started with them - no sign up or log in required. Now that we support 21 top APIs including Twitter, Facebook, Twilio, Instagram, GitHub and Foursquare (and stay tuned for more!), the Providers page makes it easy to see and start.
New Version of the Console, Now With A Better Way to See API Resources
We've also been improving and beta testing a new version of the API Console, designed to make working with your favorite APIs faster and more intuitive. You asked for a better way to explore all of the resources an API has to offer, so as part of the "v2" experience, we just launched a new API Resources page. It lets you quickly view all of the resources available (with auth requirements and color-coded verbs), find the ones you want to play with, and launch the API Console - prepopulated with your request.
Right now the new version is only available for Twitter, and we want to hear your feedback. Email .(JavaScript must be enabled to view this email address) or sign up for our beta group. (You can still get the original Twitter Console on Twitter's developer portal).
Instagram’s New API Console »
We're excited to say that Instagram now has an Apigee API Console, available both on Apigee and in the Instagram developer portal. Instagram has an impressive open platform for their hugely popular photo sharing app, one which has really demonstrated the power of APIs and developer ecosystems in building adoption, innovation, creativity and reaching new channels. Just this month they reached over 150 million photos, fueled in part by their ecosystem of integrations and apps made possible with their API.
With the Apigee API Console, Instagram developers will be able to learn, test, explore and debug the API more easily and build apps faster. And for Apigee users, the Instagram API is the first API we've added to our list of API Consoles that lets you incorporate photosharing. We think it's a great addition to our collection of the most popular APIs. We've also added Bit.ly, Gowalla, the New York Times, Shopping.com and Reddit, in addition to favorites like Twilio, Twitter, Facebook and Salesforce that are already up. And if you have your own API you want an API Console for, use Apigee To-Go to build, skin and embed on your own site.
And tell us feedback and what API Consoles you want to see next!
7 New API Consoles: Reddit, NY Times, Instagram, Tumblr, Delicious, Bit.ly and more! »
One of our missions here at Apigee is to make it easier and faster to use APIs. Our API Consoles are part of that mission: interactive, social tools to learn, test and debug APIs. API Consoles let you authenticate in seconds, view request and response pairs, drill into errors and share what you are seeing. In addition to Apigee To-Go, which lets you build your own API Console and embed it wherever you want, we're building out Apigee.com/console with a bunch of the most popular APIs. Today we launched API Consoles for some of your - and our! - favorite APIs: Reddit, the New York Times, Instagram, Delicious, Bit.ly, Shopping.com and Gowalla!
Check out this intro to using the API Consoles:
These new API Consoles join favorites like Twitter, Facebook, Salesforce, Github and more, so you can now access over 20 of the most popular APIs on Apigee. Tell us other APIs you want to see at console -at- apigee.com, or send us your feedback and feature requests.
Apigee To-Go: Build, Skin, and Embed Your Own API Console, Free »
Last year we set out to reinvent how developers approach and explore APIs. The result was the Apigee API Console, which lets developers view the full surface area of an API, authenticate in seconds, easily view API requests and responses, dig into errors and share their results. We've made API consoles for Twitter, Facebook, Salesforce and more available on Apigee.com, but time and again we've heard API providers ask for a way to build their own consoles and give it to their own developers, on their own sites…
So today we're launching Apigee To-Go, which lets you create your own API Console, skin it with the look and feel to match your brand, and then embed it where your developers are, on your own site or portal — for free. We're excited to announce that LinkedIn, PayPal and SoundCloud are already offering API Consoles custom-built for their APIs on their own developer portals.
The top benefits an API Console provides to your developers:
- Documentation is important, but interaction is critical.The API consoles gets developers from exploring to coding faster.
- Authentication schemes like OAuth slow developers down. Apigee's API Console handles OAuth 1.0, OAuth 2.0 and basic so authentication won't get in the way.**
- It's the best way to demonstrate an API, something developer evangelists and support teams need to do all the time.
- The ability to share snapshots of a request/response pair makes debugging social and facilitates communication between the API team and its developers.
We want to hear your thoughts, feedback and experience, so check out our support site or connect with us on Twitter.
New API Console for the Salesforce REST API - In Time for Dreamforce! »
In time for the Salesforce Dreamforce conference and the Cloudstock hackathon, we're excited to launch Apigee API console support for Salesforce's new REST API. The Salesforce API Console makes it easy to view requests and responses to the API, explore the surface area, drill into errors, debug and share what you are seeing with others. It also makes it a simple task to authenticate with Salesforce so that you can begin exploring the API right away. Check out this video:
Salesforce's new REST API is not yet publicly available. You can apply for access to the developer preview here.
We'd love to hear your feedback on the new Salesforce API console. Shoot us a note on Twitter or let us know in our support forum. And if you're at Cloudstock, make sure to say hi - we've got a booth - and check out ReadWriteWeb's Cloudstock data visualization contest- mine the tweet stream to get deeper insight about Dreamforce and express that data in new ways. See you there!
