For the complete documentation index, see llms.txt. You can also append .md to any page URL to get its markdown version.
Skip to main content
For the complete documentation index, see llms.txt.

For the complete documentation index, see llms.txt

REST API guide

Introduction​

The Encap REST API is used to integrate client systems with the Encap server in order to perform mobile authentication of customers with designated mobile applications that integrate the Encap mobile authentication API.

Operations provided by the API are divided into two categories:

  • Service provider API: This supports actions for enrolments, authentications, device management, application management and statistics.
  • Admin API: This supports server administrators that should have full access to the Encap server and manage resources that are shared between organisations.

Documentation​

Service provider API documentation​

The Encap REST API documentation is available as part of the distribution on a running Encap instance. To find this, go to the URL <local_encap_url>/api/docs/index.html.

You can also look at the documentation for the latest Encap release on our public test server.

Admin API documentation​

The Encap Admin REST API documentation is available as part of the distribution on a running Encap instance. To find this, go to the URL <local_encap_url>/admin-api/docs/index.html.

You can also look at the documentation for the latest Encap release on our public test server.

Suppress event callbacks for device operations​

Some device management operations can trigger event callbacks when your application configuration subscribes to the relevant event. For the supported operations listed below, you can suppress the event callback for a single REST operation by adding the optional query parameter suppressEventCallback=true.

The parameter has the following behaviour:

  • Default: false, so existing integrations continue to receive event callbacks.
  • Scope: Only affects event callbacks for the REST operation where it is set.
  • On-demand callbacks: Does not affect on-demand callbacks for activation or authentication sessions.
  • Device groups: Suppresses only the event callback for the operation you request. If the operation also changes the device group of the device, the device group event callbacks are still sent.

Supported operations​

The parameter is supported by the following service provider API endpoints:

Device group callbacks​

If you deactivate a device with suppressEventCallback=true and the device is in a device group, DEVICE_DEACTIVATED is suppressed, but one device group event callback is still sent:

  • DEVICE_GROUP_UPDATED if other devices remain in the group.
  • DEVICE_GROUP_DELETED if it was the last device in the group and the group is deleted.

To leave out device group events caused by your own REST calls, subscribe with the DEVICE API filter. For example:

DEVICE_GROUP_UPDATED:[DEVICE],DEVICE_GROUP_DELETED:[DEVICE]

You still receive device group events caused by end-users in the app.

Getting started​

Authentication for REST API calls is to handled using Basic Authentication.

Note

This authentication is not the same as the authentication service.

  • All requests are required to have an authorisation header containing a Basic Authentication string.
  • The Basic Authentication should have the API key ID as the username, and the API key secret as password.
  • API key provisioning is handled by the Encap server administrator.

To learn how to set up the authentications keys, see the Generate API keys for REST authentication section on our Server configuration page.

Example Postman collection
Explore our example Postman collection
On this page