Authenitication

EpisXperience authenticates your API requests using your API keys.

If a request lacks a valid key or deleted or expired key is used, an Unauthenticated access error will occur. In case user tryes to access API resources he doesn't have access to, an Access denied error will occur.

To sign request user has to create a valid API Key in Space Settings → API Keys. This signature must then be added to the request in the HTTP Authorization header. This document describes the process of creating the signature and signing the request. Getting started section provides planty of clear examples on how to send your first REST requests.

Each API Key is unique for the whole EpisXperience platform. API Keys is used to authoraze incomong API requests and also to identify a Tenant and a Space.

API Key generation and usage

A user can create API Key and use it to sign API request by following this procedure:

1. Login into EpisXperience and navigate to Space Settings → API Keys.

2. Create new API key by clicking on Create API key button and entering the following details:

   1. Name

   2. Description (optional)

   3. Validity

   4. Permisions

Complete the creation of API Key by clicking Create button. A pop-up window will appear showing a API Key. This API Key will be shown only once, therefore, it must be stored in the safe place.

3. Add the API Key to the Authorization header of the HTTP request.