Was this helpful?

Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}

API Resource Path: /apiproducts
A list of URIs with an associated Quota (or "service plan"), which is used to expose customized API bundles to different developer groups.

API products enable you to bundle and distribute your APIs to multiple developer groups simultaneously, without having to modify code. An API product consists of a list of API resources (URIs) combined with a Service Plan (rate-limiting policy settings) plus any custom metadata required by the API provider. API products provide the basis for access control in Apigee, since they provide control over the set of API resources that apps are allowed to consume.

As part of the app provisioning workflow, developers select from a list of API products. This selectiom of an API product is usually made in the context of a developer portal. The developer app is provisioned with a key and secret (generated by and stored on Apigee Edge) that enable the app to access the URIs bundled in the selected API product. To access access API resources bundled in an API product, the app must present the API key issued by Apigee Edge. Apigee Edge will resolve the key that is presented against an API product, and then check associated  API resources and quota settings.

The API supports multiple API products per app key--your developers can consume multiple API products without requiring multiple keys. Also, a key can be 'promoted' from one API product to another. This enables you to promote developers from 'free' to 'premium' API products seamlessly and without user interruption.

Create an API product Detail
/apiproducts
Verb: POST
Description: Create an API product: a list of API resources (URIs) combined with Quota settings that you can use to deliver customized API bundles to your developers.
Media types:
application/json
text/xml
Auth: Basic Auth
Delete an API product Detail
/apiproducts/{apiproduct_name}
Verb: DELETE
Description: Deletes an API Product
Auth: Basic Auth
Get an API product Detail
/apiproducts/{apiproduct_name}
Verb: GET
Description: Gets an API Product
Media types:
application/json
text/xml
Auth: Basic Auth
Get keys, apps, developers, or companies for an API product Detail
/apiproducts/{apiproduct_name}?query=list&entity={entity_name}
Verb: GET
Description: Gets the keys/apps/developers for an API product of an organization
Media types:
application/json
text/xml
Auth: Basic Auth
List API products Detail
/apiproducts
Verb: GET
Description: Lists all API Products by name for an organization
Media types:
application/json
text/xml
Auth: Basic Auth
Search API Products Detail
/apiproducts
Verb: GET
Description: Returns a list of API products filtered by attribute names and values
Media types:
application/json
text/xml
Auth: Basic Auth
Update API Product Detail
/apiproducts/{apiproduct_name}
Verb: PUT
Description: This method updates an existing APi Product
Media types:
application/json
text/xml
Auth: Basic Auth

 

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?)