Applications

The EVRYTHNG Platform allows developers to create applications inside their projects. An application resource will usually correspond to an actual web or native applications (remote HTTP clients) that can interact with the EVRYTHNG API. The purpose of this resource is to grant API keys and manage users on behalf of the real-world app.

In this way all resources that are associated with the real-world counterpart app can be correctly scoped and grouped accordingly, for the purpose of the application as well as its users. Multiple applications can exist inside a project resource, with each granted its own Application and Trusted Application API Keys that can be used to manipulate only those resources in the application's project scope.

API Status General Availability: /applications/me /projects/:projectId/applications /projects/:projectId/applications/:applicationId /projects/:projectId/applications/:applicationId/secretKey

ApplicationDocument Data Model

See also: ScopesDocument

Filterable Fields

This resource type can be filtered using the following fields and operators.


Create an Application

Creates an application within the project specified with projectId.

The object returned contains the appApiKey parameter, which is an Application API key that must be used within an external application to issue calls to the API. However, because this API key can be hard coded within external applications (e.g. mobile/JS) and is visible to anyone, it can be used only for a very limited set of operations (create users, read a product, send actions etc.).


Read Applications in a Project

Read a list of applications within the project specified with projectId. The result may be paginated if there are more than 30 items.


Read an Application

Returns a single application matching the applicationId within the project specified by projectId.


Update an Application

Update a single application by ID.


Delete an Application

Delete an application by ID. This action cannot be undone.


Read the Trusted Application API Key

Read the Trusted Application API Key for the application with applicationId. This is a secret key that has access to more endpoints than the standard Application API key.

Note

Operator users with read-only permissions (i.e.: global_read and project_read) will not be able to see this endpoint, or read the Trusted Application API Key.


Read Self Application

An application can read its own metadata without knowledge of which project it is in using the /applications/me endpoint with its Application API key.


Update Self Application

The /applications/me endpoint can also be used to allow an application to update its own meta data using its Trusted Application API Key.