Getting Started

The App Registry manages applications and the activation of tenants on those applications. Once an application is created, an application developer is provided with an API key that can be utilized to call the API as an application. To use the API key, the application simply provides it in the X-API-KEY header.

Once an application is created, tenants may activate the application through a one time password operation. The tenant requests a one time password from the application store and provides that to the application at a URL defined by the application. The application then redeems this one time password with the App Registry in exchange for the credentials, that enables the application to perform further operations under the tenant's identity.

The following sections describe the App Registry API that is used by an application integrating with the pxGrid Cloud subsystems.

Using an API Key

Using an API key to authorize a request to cloud services is as simple as including it in the X-API-KEY header:

GET /api/v1/.... HTTP/1.1
X-API-KEY: unQjc80hiF0W28vH254uGS8tyxPk0VoLxWTo64ONdtXxwFpl4ZlD7mAhpTzBlQDy
Accept: application/json
...

Error Responses

App Registry conforms to standard REST interpretations when issuing HTTP status codes in response to errors (non 2xx series status codes).

In the case of a non-2xx response status, a descriptive error object is returned, for example:

HTTP/1.1 404 Not Found
Content-Type: application/json

{ 
  "error": "Application not found"
}