Client Applications and API Keys

Use Client Applications and API Keys to authenticate with the public awork API, whether you're building your own app, an integration, or connecting business intelligence (BI/analytics) tools.

Key benefits and use cases

Choose the authentication method that suits your use case:

• User sign-in with user permissions for apps where each person signs in with their own awork account and their permissions are applied
• API key without a user account (admin permissions) for analytics, interfaces, and similar use cases that don't require users to sign in
• Build custom apps and integrations using the awork API, the same foundation the web app is built on

How to use Client Applications and API Keys

awork supports two common approaches. Choose the one that suits your scenario.

Create a Client Application for user sign-in (OAuth 2.0)

Use this option if you want users to sign in to your app or integration with their own awork account.

1. Go to Einstellungen (the gear icon in the bottom-left corner of the main menu)
2. Open Integrationen and go to API Clients
3. Click + API Client
4. Enter a Name and a Client ID (this ID must be unique)
5. Add a Redirect URL (see Developer Resources for details)
6. Click Speichern
7. After saving, copy the Client Secret and store it securely
8. Use the Client ID and Client Secret to implement your OAuth 2.0 sign-in, so users can authenticate with their awork account.

For more information about OAuth 2.0 sign-in, see the Developer Resources.

Create an API key without user authentication

Use this option if you only need an API key to retrieve data or run an integration that doesn't require users to sign in.

1. Go to Einstellungen (the gear icon in the bottom-left corner of the main menu)
2. Open Integrationen and go to API clients
3. Click + API Client to create a new Client Application
4. Enter a Name and a Client ID (this ID must be unique)
5. Click Speichern
6. Select your new application from the list of Client Applications
7. Click the three-dot icon and select API-Keys verwalten
8. Click + to add a new API key
9. Click the small key icon on the right to copy the API key
10. Store the API key securely and use it for your integration or data query

See the Developer Resources to learn more about using the API key.

Best practices and support

• Store secrets and API keys securely after copying them
• Use a unique Client ID when creating a Client Application
• See the Developer Resources for details on implementing OAuth 2.0 and API keys

FAQ

What's the difference between a Client Application and an API key?

A Client Application is created in awork to enable authentication. Depending on your use case, you can use it for user sign-in (OAuth 2.0) or to generate an API key for data queries and integrations.

When should I use user sign-in (OAuth 2.0)?

Use it when you want users to sign in with their own awork account and have user permissions applied.

Do I need a Redirect URL?

For user sign-in (OAuth 2.0), you need to add a Redirect URL (see the Developer Resources for details). If you only need an API key, the Redirect URL isn't relevant.

What are a Client ID and Client Secret?

When you create a Client Application, you set a unique Client ID. After you save the application, you'll receive the Client Secret, which you should copy and store securely.

Where do I create Client Applications in awork?

Go to Einstellungen → Integrationen and scroll to API Clients. You need admin permissions.

Where can I learn more about API authentication?

See the Developer Resources. For specific information about API keys, see Authentication: API Key.