Application¶

An application is the backend of your client application. It encapsulates your data model (entities), security rules, file storage, email configuration, custom endpoints, and reports.

Create¶

To create a new Application you need to define:

Upon creation, the application receives:

• A unique Application Token (GUID) — used to identify the application in every API request
• An Encryption Key — used for encrypting sensitive data
• Default system entities: Users and Files

Application settings¶

After creating an application, you can configure these settings from the Portal:

Authentication¶

Files¶

Email¶

SMTP settings for sending confirmation and password reset emails. See Email Templates for details.

Networking¶

Advanced¶

Differentiation entity¶

A differentiation entity allows you to conceptually "split" data on the application entities, depending on a system property on the system entity Users.

How it works¶

For example, if you are building an application shared between multiple companies, you can set a differentiation entity named Company. Then, each user will have access only to records of the company they are assigned to.

When a differentiation entity is set:

1. A new entity is created with that name (e.g., Company)
2. The Users entity gets an extra system property named {Entity}_ID (e.g., Company_ID)
3. Every subsequent entity you create has the option to include a differentiation property
4. On every API call, Apilane automatically appends a filter based on the user's differentiation value

It is a client application concern to decide how to assign values to that differentiation entity property for each user. For example, the application developer can use a Custom endpoint to assign the proper differentiation property value to a new user, depending on application needs.

Example¶

A new Application is created with Differentiation entity Company. Apart from the typical system entities, a new entity is created named Company. Additionally, on system entity Users there is an extra system property named Company_ID.

Every new user that is registered to the application, will by default be assigned the value null on the differentiation property Company_ID.

On every subsequent entity that is created, there is the option to add a differentiation property or not. That is because some entities may hold data that should be common for all companies. On entities where this option is enabled, an extra system property named Company_ID will appear.

If User_A creates a record on a differentiated entity, the record column Company_ID will have value null. If User_B creates a record, the record column Company_ID will have value 1. Subsequently, all users with the same differentiation value will see only their group's records.

Application lifecycle¶

Collaboration¶

Applications support a collaboration model where multiple Portal users can manage the same application. The application owner can invite collaborators through the Portal.