Example Postman collection

Service provider REST APIs

You can use these REST APIs to manage and perform operations for resources belonging to a specific organisation.

Prerequisites

• You need an API key ID and secret, that belong to a standard organisation.
  • To generate on a local server, see the Generate API keys for REST authentication section on the Server configuration page to generate an API key.
• Download and install the latest version of Postman.
• Download the example Postman collection and environment for Encap SCA, using the buttons below:

   

Setup

1. Import the collection and environment. To do this, drag-and-drop.
2. Configure the environment. To do this, click on the settings icon in the top-right corner.
   1. Update the service_url if needed. The default is the Encap public test environment (PT).
   2. Set up Basic Authentication by adding your key_id and key_secret.
   3. Set the application_id, which is used in start enrolment.

API reference documentation

API reference

Explore endpoints and properties with example requests and responses

Encap server administrator REST APIs

You can use these REST APIs to manage resources that are shared across all organisations.

Prerequisites

• You need an API key ID and secret, that belong to an admin organisation.
  • See the Generate API keys for REST authentication section on the Server configuration page to generate an API key.
• Download and install the latest version of Postman.
• Download the example Postman collection and environment for Encap SCA, using the buttons below:

   

Setup

1. Import the collection and environment. To do this, drag-and-drop.
2. Configure the environment. To do this, click on the settings icon in the top-right corner.
   1. Update the service_url if needed. The default is the Encap public test environment (PT).
   2. Set up Basic Authentication by adding your key_id and key_secret.

API reference documentation

API reference

Explore endpoints and properties with example requests and responses