API Platform Base Path: https://api.enterprise.apigee.com/v1/o/{org_name}
API Resource Path: /developers/{developer_email}/apps
Creates an App associated with a Developer
Verb: POST
Auth: Basic AuthOptional elements: AccessType, CallbackUrl, ApiProducts, Attributes Note: CallbackUrl can be â,â separated multiple callback URLsâ.
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"
}' \
-u myname:mypass https://api.enterprise.apigee.com/v1/o/{org_name}/developers/{developer_email}/apps
Request Payload Elements:
| Name | Description | Default | Required? |
|---|---|---|---|
| accessType | Legacy Apigee-specific element, unused in current version of Apigee | N/A | No |
| attributes | Arbitrary name/value attributes that may be used for customizing profile information or for app specific processing. | N/A | No |
| callbackUrl | A URL that can be used by the API to programatically update consumer Apps, Unused by Apigee. Can be multiple comma separated values. | N/A | No |
| name | The name of the app | N/A | Yes |
| apiProducts | A list of API products with which the app is associated | N/A | Yes |
{
"accessType" : "read",
"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 |
|---|---|
| accessType | Unenforced by Apigee |
| attributes | Name/value formatted attributes used to extend the default profile |
| callbackUrl | A URL that can be used for app specific callbacks |
| createdAt | Unix time when the app was created |
| createdBy | User name of the Apigee user 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 user who last modified the app |
| name | Name of the app |
| status | Status of the app: 'approved' or 'unapproved' |
