Beta Release of SmartDocs

The Beta release of SmartDocs lets you try the Apigee Edge management APIs. How does it work?

1. In the Resource URL, replace any values enclosed in "{}", such as your organization name.
2. Set the Basic Authentication credentials. These are your Edge credentials (user must be in the Org Admin role).
3. Select Send this request to send the live request to Edge and to view the response.

Resource Summary

Auth Type

BASICAUTH,

Content Type

application/json, text/xml

Category

API Product,

createApiProduct

POST

Create API Product

Creates an API product in an organization.

You create API products after you have proxied backend services using API proxies.

An API product is a collection of API resources combined with quota settings and metadata that you can use to deliver customized and productized API bundles to your developer community. This metadata may include scope, environments, API proxies, and an extensible profile.

API products enable you repackage APIs on-the-fly, without having to do any additional coding or configuration.

We recommend that you start with a simple API product including only required elements. You then provision credentials to apps to enable them to start testing your APIs.

Once you have authentication and authorization working against a simple API product, you can iterate to create finer-grained API products, defining different sets of API resources for each API product.


See What is an API product? for more.

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/apiproducts

    Header Parameters

  • Name
    Value
    Description
  • Content-Type
    (required)
    Specify the content type as application/json or text/xml.

Request Body

Name Description Default Required?
approvalType Manual or Auto. If Manual, consumer key is generated and returned in 'pending' state. If manual consumer key generated and returned in 'Approved' state. N/A Yes
attributes Arbitrary name/value pairs N/A No
description An overview of the API product. Include key information about the API product that is not captured by other fields. N/A No
displayName The name to be displayed in the UI or developer portal to developers registering for API access N/A Yes
name The internal name of the API Product. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. N/A Yes
apiResources A comma separated list of API resources to be bundled in the API Product. N/A No
environments A comma-separated list of environment name in an organization. Requests to environments not listed are rejected. N/A No
proxies A comma-separated list of API proxy names in an organization. Requests to API proxies not listed are rejected. Api proxy names included here must already exist in the environment specified in the environment property because API Services validates proxy names when you create an API product. N/A Yes
quota The number of request messages permitted by this API product. N/A Yes
quotaInterval The time interval over which the number of request messages is calculated. N/A Yes
quotaTimeUnit The time unit defined for the quotaInterval N/A Yes
scopes A comma separated list of scopes. These must map to the scopes defined in an Oauth policy associated with the API Product. Any scope mismatch between an Acces Token presented and the API Product results in auth failure. N/A No

org_name Mention the Organization name true

Basic Auth

OAuth 2

Custom Token

Reset

Make a request and see the response.

Make a request and see the response.

Working...

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