User App

Create user apps, approve or revoke subscriptions, and fetch app details and credentials.

Authentication

All methods require a valid Platform API key in the x-yappes-key header.

Base URL

Substitute the sample host https://platformapi.enterprise-xyz.com with the Platform API URL configured for your Yappes organization, since the host value changes depending on the organization and deployment setup.

---

REST Resources

Resource	Methods
organizations.users.apps	create, setStatus
organizations.apps	get

---

Resource: organizations.users.apps

User application creation and status management.

---

Platform API — Create User App

Creates an app for a user.

HTTP request

POST https://platformapi.enterprise-xyz.com/v1/organizations/{orgReferenceId}/users/{userReference}/apps

Path parameters

Parameter	Type	Description
orgReferenceId	string	Required. Organization reference.
userReference	string	Required. User reference (userId, email, or username).

Query parameters

None.

Request body

{
  "name": "my-app",
  "apiProducts": ["Premium Tier Flat Rate Plan"],
  "attributes": [],
  "callbackUrl": ""
}

Field	Type	Required	Description
name	string	Yes	App name. Also accepted as applicationName.
apiProducts	array	Yes	Non-empty array of API product (rate plan) names.
attributes	array	No	Custom attributes.
callbackUrl	string	No	OAuth callback URL.

Response body

If successful (200 or 201), the response body contains the created app details.

Authorization

Requires a valid x-yappes-key header.

---

Platform API — Enable / Disable App

Approves or revokes a user app (enables or disables its subscription).

HTTP request

PUT https://platformapi.enterprise-xyz.com/v1/organizations/{orgReferenceId}/users/{userReference}/apps/{appName}?action={action}

Path parameters

Parameter	Type	Description
orgReferenceId	string	Required. Organization reference.
userReference	string	Required. User reference.
appName	string	Required. Application name.

Query parameters

Parameter	Type	Description
action	string	Required. approve (enable) or revoke (disable).

Request body

The request body must be empty.

Response body

If successful, the response body is:

{
  "appId": "APP-D5496B8D",
  "name": "my-app",
  "userId": "USR-183152C2",
  "status": "approved",
  "createdAt": "1783185381000",
  "lastModifiedAt": "1783185381000",
  "credentials": [
    {
      "consumerKey": "…",
      "consumerSecret": "…",
      "status": "approved",
      "apiProducts": [
        { "apiproduct": "Premium Tier Flat Rate Plan", "status": "approved" }
      ],
      "expiresAt": "-1"
    }
  ],
  "appFamily": "default"
}

Authorization

Requires a valid x-yappes-key header.

---

Resource: organizations.apps

Organization-scoped application lookup.

---

Platform API — Fetch App Details

Gets the profile for an app in an organization.

HTTP request

GET https://platformapi.enterprise-xyz.com/v1/organizations/{orgReferenceId}/apps/{appReferenceId}

Path parameters

Parameter	Type	Description
orgReferenceId	string	Required. Organization reference.
appReferenceId	string	Required. Application id (APP-…).

Query parameters

None.

Request body

The request body must be empty.

Response body

If successful, the response body is:

{
  "appId": "APP-D5496B8D",
  "name": "my-app",
  "userId": "USR-183152C2",
  "userEmail": "info@yappes.com",
  "status": "approved",
  "createdAt": "1783185381000",
  "lastModifiedAt": "1783185381000",
  "credentials": [
    {
      "consumerKey": "…",
      "consumerSecret": "…",
      "status": "approved",
      "apiProducts": [
        { "apiproduct": "Premium Tier Flat Rate Plan", "status": "approved" }
      ],
      "expiresAt": "-1"
    }
  ],
  "attributes": [],
  "callbackUrl": "",
  "scopes": [],
  "keyExpiresIn": "-1"
}

Authorization

Requires a valid x-yappes-key header.

---

Method index

#	HTTP	Path
1	POST	/v1/organizations/{orgReferenceId}/users/{userReference}/apps
2	PUT	/v1/organizations/{orgReferenceId}/users/{userReference}/apps/{appName}?action={action}
3	GET	/v1/organizations/{orgReferenceId}/apps/{appReferenceId}