The awork web app is a single page application (SPA) that communicates with the awork server cluster via the awork API. This API is public and therefore accessible for building your own apps, integrations, or connecting Business Intelligence Tools (BI / Analytics).

However, public means that an appropriate authentication must be made.

API key with user rights

If the users themselves are to be able to log in to the specially developed app/integration with their awork account, a new client application must be created in awork for this purpose.

☝️Note: The user login is important for apps and applications where the user's rights management is to take effect (this is done via oAuth 2.0 - more on this in the Developer Resources).

API key without user reference with admin rights

If this doesn't matter, you can also generate an API key without user reference with admin rights, e.g. for analytics, interfaces, etc. Here you can find out how to get the key.

Clients for own apps with user login

If you want to build your own app for awork, where the users should log in themselves, you need to create a client application in awork.

In the main menu, go to Settings and then to the Integration section. There you will find the Client Applications section.

  1. Click on + to create a new client application.

  2. Create a name and a client id (this id must be unique).

  3. Add a Redirect URL (see Developer Resources for more details).

  4. Save the client application.

  5. After saving, you will get the client secret. Copy it and keep it safe..

  6. With the client id and the client secret, you'll be able to build your own oAuth 2.0 login where users can authenticate themselves with their awork account.

Check out our Developer Resources to learn more about oAuth 2.0 login.

API Key without User Authentication

If you wish to build an integration for awork or just need an API key to query data, you'll need to create a client application and generate an API key.

  1. In the main menu, go to Settings and select the Integration section. There you will find the Client Applications section.

  2. Click on + to create a new client application.

  3. Set a name and a client id (this id must be unique).

  4. The redirect URL is not relevant in this case because only the API key is needed..

  5. Close the window with the client's secret.

  6. Your new application will now appear in the list of client applications.

  7. Click on the more button (3 dots icon) and select Manage API Key.

  8. Use the + button to add a new API key.

  9. Click the small key icon on the right side and copy the API key.

  10. Copy the API key to the clipboard and keep it safe. You'll be able to use it for your integration or data query.

  11. Check out our Developer Resources to learn how you'll be able to work with the API key.

Did this answer your question?