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

Developer App,

createDeveloperApp

POST

Create Developer App

Creates an app associated with a developer.

The name is the unique ID of the app, which can be different from the DisplayName attribute value that is displayed in the Apigee Edge management UI. If you don't provide a DisplayName when you create a developer app with this method, the name is used.

Resource URL

https://api.enterprise.apigee.com/v1 /organizations/{org_name}/developers/{developer_email}/apps

    Header Parameters

  • Name
    Value
    Description
  • Content-Type
    (required)
    Specify Content Type.

Request Body

Name Description Default Required?
name The name of the app. The name becomes the unique ID of the app for this organization and developer. Characters you can use in the name are restricted to: A-Z0-9._\-$ %. N/A Yes
apiProducts A list of API products with which the app is associated. The name of the API product is the name returned by a GET request to the "List API Products" endpoint. For example, if the Display Name of the API product in the Apigee Edge management UI is 'Premium API Product', then the name is 'premium-api-product' (all lowercase with spaces replaced by hyphens). N/A Yes
keyExpiresIn A setting, in milliseconds, for the lifetime of the consumer key that will be generated for the developer app. The default value, -1, indicates an infinite validity period. -1 No
scopes The scopes to apply to the app. The specified scope names must already exist on the API product that you associate with the app. N/A No
attributes Name/value pairs that may be used for customizing profile information or for app-specific processing.
  • DisplayName (see the sample request body) is an attribute that provides the app name in the Edge management UI. This can be different from the name (unique ID) of the app.
  • The Notes attribute lets you add notes about the developer app.
  • Any other arbitrary name/value pairs you create are included as custom attributes.
N/A No
callbackUrl The callbackUrl is used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. See the documentation on OAuth 2.0 for more details. N/A No, with the exception of 3-legged OAuth 2.0.

org_name Mention the organization name true

developer_email Mention the developer email true

org_name Mention the organization name true

developer_email Mention the developer email true

Basic Auth

OAuth 2

Custom Token

Reset

Make a request and see the response.

Make a request and see the response.

Response Payload Elements

Name Description
createdAt Unix time when the app was created
createdBy User name of the Apigee developer who created the app
credentials A set of credentials for the app--credentials are app key/secret pairs associated with API products
apiProducts A list of API products with which the app is associated
status The status of the API product association: 'approved' or 'pending'
attributes Name/value pairs used to extend the default app profile
consumerKey The value of the consumer key for the app
consumerSecret The value of the consumer secret associated with the consumer key
status The status of the consumer key: 'approved' or 'pending'
lastModifiedAt Unix time when the app was last modified
lastModifiedBy User name of the Apigee developer who last modified the app
name Name of the app. The name is the unique ID of the app for this organization and developer.
status Status of the app: 'approved' or 'unapproved'
attributes Name/value formatted attributes used to extend the default profile
callbackUrl The callbackUrl is used by OAuth 2.0 authorization servers to communicate authorization codes back to apps. CallbackUrl must match the value of redirect_uri in some OAuth 2.0 See the documentation on OAuth 2.0 for more details.
application/xml

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