Overview

The Workduo Reporting API uses Basic Authentication to secure access to its endpoints

Users authenticate by providing a username and password which are encoded in the HTTP Authorization header.

Retrieving Your API Keys

1. In your Workspace > General Settings > API Section: Add an API.
2. Copy the Public Key and Secret Key
3. These will be your API credentials
   1. use the Public Key as your username
   2. use the Secret Key as your password

Using Basic Authentication

Our API requires Basic Authentication for all requests. To authenticate, include an Authorization header with your Public Key and Secret Key, encoded in Base64 format.

1. Format your Public Key and Secret Key as public_key:secret_key.

Example: For Public Key user_acme_12345 and Secret Key sk_9876543210abcdef, combine as user_acme_12345:sk_9876543210abcdef.

2. Encode in Base64:

Example: user_acme_12345:sk_9876543210abcdef encodes to dXNlcl9hY21lXzEyMzQ1OnNrXzk4NzY1NDMyMTBhYmNkZWY=.

3. Add to Authorization Header: Include the Base64-encoded string in the Authorization header as Basic.

Example: Authorization: Basic dXNlcl9hY21lXzEyMzQ1OnNrXzk4NzY1NDMyMTBhYmNkZWY=.

Other Requirements

Each API Request will require to pass the Project ID in the field projectId to specify the project to use for the API.