• Nonexistent node nid: 21.
  • Nonexistent node nid: 21.
Was this helpful?

Your developers, both internal and external, as well as your partners, build apps that access your APIs through API products. The API products you define provide access to the resources in your APIs. To control this access, you first add an API in Apigee and then set up an API product. Developers select one or more API products that meet their needs for resources (functionality and data) and performance (service plan).

When a developer registers an app in Apigee, an API key and associated secret are generated for the app. The API key and secret are used at runtime to obtain access to API products. Developers embed this key in their app. Whenever the app makes a call, Apigee checks to make sure the correct key is being used. If the key is valid, the call can access the resources exposed in the API products.

You can configure API products for automatic or manual approval. Automatic approval is commonly used for free API products, while manual approval is used for premium products, or products that provide access to sensitive information.

You can set up a developer portal where your developers can register their apps and get access to app keys and your API products.

Adding APIs

When you add an API in Apigee, you're creating an API that acts as a proxy for an existing API. So instead of calling your existing API, your developers call the new API in Apigee. This lets you provide a stable front end to your developers as you update and innovate the services you want to provide. You can add your own APIs or third-party APIs to your organization, and you can add resources for each API.

To add APIs

  1. Select the APIs tab
  2. Click the add (+) API Proxy button to open the New API Proxy page.
  3. In the "Choose your starting point section, select "Existing Backend Service".

    Note: Alternatively, you can select either of the following:

    • Existing Apigee API Bundle, to import a zip file that contains the configuration files for an API proxy, including policies and (optionally) custom scripts and code.
    • Existing WSDL, to expose a WSDL-based SOAP service as a RESTful API.

      See

      Nonexistent node nid: 21.
      for further information about these selections.

  4. Enter the Backend Service URL.
    This is the network address where Apigee directs app requests. An example is www.example.com.
  5. In the "Identify your API Proxy" section, enter a descriptive name for your API as the Display Name.
    You can use your brand name so developers can easily identify your organization as the API provider.
  6. Enter a Project Name.
    The Project Name will be appended to the proxy URL that apps call to invoke your API. The API Platform uses the proxy URL to match and route incoming request messages to the proper API proxy. The base of the API URL is automatically generated based on your organization and environment. It’s good practice to include a version number in the project name, such as v1.
  7. Optionally, add security and support for CORS (Cross-origin resource sharing) in the Add Features section.
  8. Click Build.

Your new API is added to the default API product and appears in the summary list. As you direct traffic to the API proxy, the system automatically generates the basic API metrics, such as throughput and response time.

See also

  • Nonexistent node nid: 21.
    for a detailed discussion.

Adding an API product

In Apigee, an API product is a group of API resources bundled together. The API product includes some metadata and a service limit that can be accessed by your developers using a key. Think of API products as your product line. You can create different products to provide features for different use cases. So instead of just giving developers a list of resources, you can bundle specific resources together to create a product that solves a specific user need. For instance, you can create a product that bundles a number of mapping resources to let developers easily add maps to their applications. API products let you differentiate your API from the crowd, by providing solutions and not just resources.

To add API products

  1. Click the Publish tab, then Products
  2. Click the add (+) Product button.
  3. On the Add Product page, enter a name and description for the product.
  4. Select the test environment for internal-facing products or the production environment for public-facing products.
  5. Enable an access level option. These options determine who can access the product. You can use these levels to control access at different stages of development. For example, you can set a product to Internal Only while it's in development and then change access to Public when it's ready to release.
  6. Select automatic key approval or manual key approval.
    If you select automatic key approval, all key requests that come in from any app that uses this API product are automatically approved. If you choose manual key approval, you will have to approve key requests that come in from any app that uses this API product.
  7. Enter a service limit number and select a time period (minute, hour, day, week, month). This sets up a quota for your product that limits the number of calls the product accepts in a given time period.
  8. Enter a scope for the product (such as 'Read'). The scope should match one of the scopes you defined in your security policy. If they don't match your API may not be secure.
  9. In the API Resource Paths for Product section, select the API, Revision, and Resource Path for the API you want to add.



    If you want to add the entire API to the product, choose /** for the Resource Path.
  10. Click click Import Resource Path, then click Save. The new product appears in the table on the Products page.

See also

Creating API products

Adding a developer

Developers access your APIs through apps that contain keys, which in turn provide access to your API products. Keys are generated when you set up an app and add API products to the app. However, you can't create an app without a developer, so you need to have developers registered in your organization. If you have a public API product that developers can sign up for via a portal, developers register themselves because they want to access your APIs. However, in some cases you'll need to add a developer manually. For example, if you need to add internal developers or create a developer on behalf of a customer.

The Developers page, which you can view by selecting the Onboard tab, then Developers, provides information on the number of apps developers have created, and the number of keys they're using.

To add a developer

  1. Click the Publish tab, then Developers.
  2. Click the add (+) Developer button.
  3. Enter the first name for your developer.
  4. Enter the last name for your developer.
  5. Enter the developer's email.
    This is the email address that you use to send keys and notifications to this developer.
  6. Optionally, add custom attributes for the developer. For each custom attribute:
    • Click (+) Add Custom Attribute.
    • Enter the attribute name and value.
  7. Click Save. The new developer appears in the table on the Developers page.

See also

Adding developers to your organization

Adding an app

Apps are how your developers access the resources in your API products. When you create an app, you select the API products to include, and Apigee generates a key. By default, a single key provides access to multiple API products—newly approved API products are added to the existing API key by the system.

When the application makes a request, Apigee inspects the request to verify that the API key matches the resource that the app is requesting. It checks any API product definitions associated with API key to see whether the resource is permitted. If everything lines up, Apigee sends back the requested resource data.

To add an app

  1. Click the Publish tab, then Developer Apps.
  2. Click the (+) Developer App button.
  3. Enter a name for the app.
  4. Enter the URL for the callback. A callback is the location of a resource that belongs to the applications. In most cases, this is the location of a login screen where app end users enter their username and password.
  5. Select a developer from the Developer list. Your app must have a developer.
  6. Optionally, add a descriptive note.
  7. Optionally add custom attributes for the app. For each custom attribute:
    • Click (+) Add Custom Attribute.
    • Enter the attribute name and value.
  8. Click Save. Your new app appears in the apps table on Developer Apps page.

See also

Registering apps for more on apps and keys.

Setting up a developer portal

After you add and configure your APIs, you need to provide a way for outside developers and partners to access them. You can set up a developer portal as an entry point where users can browse your API, read your API documentation, and, most importantly, get keys to access the API products you have to offer. Apigee provides a portal template you can use to showcase your APIs and develop a community with features like blogs and forums. The default setup lets you create and manage API documentation, forums, and a blog. From within the portal, your users can trace API calls in real time using the built-in test console. In addition to content management, the portal provides community management features, such as manual/automatic user registration and moderating user comments.

To create and configure your developer portal, contact Apigee Support.

See also

What is a developer portal?

Set up your developer portal

Help or comments?

  • Something's not working: See Apigee Support
  • Something's wrong with the docs: Click Send Feedback in the lower right.
    (Incorrect? Unclear? Broken link? Typo?)