Was this helpful?

 

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

API Resource Path:

/developers/{developer_email}/apps

Description: Creates an app associated with a developer

Verb: POST
Auth: Basic Auth
Media types:
text/xml
application/json

For more information on apps, see Registering apps.

Sample Request:
$ curl -H "Content-type:application/json" -X POST -d \
'{
  "accessType" : "read",
  "attributes" : [ {
	"name" : "Language",
	"value" : "java"
  } ],
  "apiProducts": [ "TestApiProduct"],
  "callbackUrl" : "www.apigee.com",
  "name" : "MyTestApp",
  "keyExpiresIn" : "1000000"
}'  \
https://api.enterprise.apigee.com/v1/o/{org_name}/developers/{developer_email}/apps \
-u myname:mypass
Request Payload Elements:
Name Description Default Required?
attributes Arbitrary name/value attributes that may be used for customizing profile information or for app specific processing. N/A No
name The name of the app. The name becomes the unique ID of the app for this organization and developer. The characters you are allowed to use in the name are restricted to the following: A-Z0-9._\-$ %. For example, Cat2 %_ is a legal name. N/A Yes
apiProducts A list of API products with which the app is associated N/A Yes
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
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
Sample Response:
{
  "attributes" : [ {
	"name" : "Language",
	"value" : "java"
  } ],
  "callbackUrl" : "www.apigee.com",
  "createdAt" : 1343052353553,
  "createdBy" : "Admin",
  "credentials" : [ {
	"apiProducts" : [ {
  	"apiproduct" : "TestApiProduct",
  	"status" : "pending"
	} ],
	"attributes" : [ ],
	"consumerKey" : "VBsAd4wO0wkevxGaqlKlVF8qlGa4ydsT",
	"consumerSecret" : "gi8yb1ZFZ7ztRhYa",
	"status" : "approved"
  } ],
  "lastModifiedAt" : 1343052353553,
  "lastModifiedBy" : "Admin",
  "name" : "MyTestApp",
  "status" : "approved"
}
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.

 

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