Authentication

The Engagement Hub API secures access to its resources through robust authentication mechanisms. Ensuring that your API interactions are authenticated is crucial for maintaining data integrity and security. This section outlines how to authenticate API requests.

Overview

Our API uses Basic Authentication. This method requires the API user to provide a valid username and password, which are encoded and included in the header of each request.

Basic Authentication

Basic Authentication is a simple authentication scheme built into the HTTP protocol. The client sends HTTP requests with the Authorization header that contains the word Basic followed by a space and a base64-encoded string username:password .

Encoding Credentials

To encode your credentials:

1. Combine your username and password with a colon (: ). For example, if your username is user123 and your password is securePassword , the string should be user123:securePassword .
2. Encode the resulting string in base64. For example, user123:securePassword would be encoded as dXNlcjEyMzpzZWN1cmVQYXNzd29yZA== .

Using Encoded Credentials

To make requests to the API, include the encoded credentials in the Authorization header of each HTTP request like this:

Authorization: Basic dXNlcjEyMzpzZWN1cmVQYXNzd29yZA==