Client Applications and API Keys

Use Client Applications and API Keys to authenticate yourself with the public awork API - whether you want to build your own app, create an integration, or connect Business Intelligence tools (BI/Analytics).

Main Benefits and Use Cases

Choose the authentication method that fits your use case:

• User login with user permissions for apps where each person logs in with their own awork account and their respective permissions are applied
• API Key without user reference (admin rights) for analytics, integrations, and similar use cases where user login isn't required
• Develop custom apps and integrations based on the awork API - the same foundation that powers the web app itself

How to Use Client Applications and API Keys

awork supports two common approaches - pick the one that matches your scenario.

Create a Client Application for User Login (OAuth 2.0)

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

1. Navigate to Settings (gear icon in the bottom left of the main menu)
2. Open the Integrations section and go to API Clients
3. Click on + API Client
4. Enter a Name and Client ID (this ID must be unique)
5. Add a Redirect URL (see Developer Resources for details)
6. Click Save
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 login so users can authenticate with their awork account

Find more information about OAuth 2.0 login in the Developer Resources.

Create an API Key Without User Authentication

Use this option when you only need an API Key to query data or operate an integration that doesn't require user login.

1. Navigate to Settings (gear icon in the bottom left of the main menu)
2. Open the Integrations section and go to API clients
3. Click on + API Client to create a new Client Application
4. Give it a Name and Client ID (this ID must be unique)
5. Click Save
6. Select your new application from the list of Client Applications
7. Click the three-dot icon and select Manage API Keys
8. Click + to add a new API Key
9. Click the small key icon on the right side to copy the API Key
10. Store the API Key securely and use it for your integration or data queries

Check out the Developer Resources to learn more about using your 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
• Use 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, it can be used for user login (OAuth 2.0) or to generate an API Key for data queries and integrations.

When should I use user login (OAuth 2.0)?

Use it when you want users to log in with their own awork account and you want to apply user permission management.

Do I need a Redirect URL?

For user login (OAuth 2.0), you must add a Redirect URL (see Developer Resources for details). If you only need an API Key, the Redirect URL is not relevant.

What are Client ID and Client Secret?

When you create a Client Application, you set a unique Client ID. After saving 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 Settings → Integrations and scroll to API clients.

Where can I learn more about API authentication?

Check out the Developer Resources. Find specific information about API Keys under Authentication: API key.