Authentication¶

WERK24 uses the AWS Cognito Service to identify a user. We decided to use this service because it provides you with two advantages:

1. The source code that handles the authentication is constantly monitored and improved by a dedicated and highly specialized team.

2. Many standard libraries exist that handle the authentication process for you.

3. We can provide you with different user names for different geographies, allowing you to be certain your customer's data does not leave its region-of-origin. See General Data Protection Regulation (GDPR).

Credentials File¶

During the registration process, WERK24 will provide you with a .werk24 file that contains all the information required to authenticate with our API. This file assumes that you have only registered one user with WERK24.

The file will look like this

W24TECHREAD_AUTH_REGION="eu-central-1"
W24TECHREAD_AUTH_CLIENT_ID="xxxxxxxxxxxxxxxxxxxxxxxxxx"
W24TECHREAD_AUTH_CLIENT_SECRET="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
W24TECHREAD_AUTH_USERNAME="xx@xx.xx"
W24TECHREAD_AUTH_PASSWORD="--- INSERT HERE ---"
W24TECHREAD_SERVER_HTTPS="techread.w24.io"
W24TECHREAD_SERVER_WSS="techread-ws.w24.io"
W24TECHREAD_VERSION="v1"

The content of the file will be used when you call the W24TechreadClient.make_from_env() method.