Working samples for the Apigee API Platform
Shell JavaScript Python XML Java
Switch branches/tags
Nothing to show
Pull request Compare This branch is 13 commits ahead, 995 commits behind apigee:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


Apigee API Platform Samples

Apigee API Platform Samples are designed to help developers learn how to use the Apigee API Platform.

Apigee's API Platform provides developers with:

  • A RESTful API to enable DIY control and oversight of APIs, apps, and developers
  • API Key and OAuth 1 and 2 support
  • Out-of-the-box policies for functionality that you would rather not code yourself (like quotas, transformations, response caching, etc.)
  • APIs and scripting support for functionality that you would rather innovate and code yourself
  • The ability to share your work with other developers, and to reuse it across your own projects, by exposing it as APIs that you own and control
  • Scalable, managed test and prod environments with operational analytics

Fully-featured, free accounts are available at:

Learn more at

Getting started

All of these samples require you to have an account on:

You can sign up for a trial account at:

Learn more at

You also require:

Python, to use the deployment tool.

Deploy all sample proxies at once:

$ cd /setup

Set your Apigee API Platform account settings in


$ sh

Note this step also deploys all API products, developers, and apps needed for OAuth.)

Navigate to /sample-proxies.

Each sample API proxy directory contains a script called that issues a curl command to the API exposed by the sample API proxy.

$ sh

If you make changes to the sample API proxy, simply run:

$ sh

in the sample AIP proxy's directory to import the proxy and deploy changes.

What's here:


A set of fully-functional API proxies that you can deploy and invoke on the Apigee API Platform. Feel free to modify them as needed. (Be sure to deploy changes for them to take effect.)


XML schemas that you can use as a reference when working with policies, API proxy configuration, API products, apps, and developers.


A basic API proxy that is used in the API Platform Developer Guide at:


Simple scripts to help you deploy the sample API proxies and profiles that they rely on, including API products, developers, and apps.

Set you Apigee API Platform account settings in

(You can obtain a free account at

To deploy a single sample, run

$ sh

And provide the name of the directory under /saple-proxies that contains the proxy you want to deploy.

To deploy all samples and API products, run:



Contains a Python deployment tool ( that imports an API proxy to an organization on the Apigee platform and then deploys it to the environment specified.

Get help and interact with other API developers

Copyright 2013 Apigee Corporation

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.