danieldaum.net
kaneo (minimalist kanban) fork to experiment adding a tangled integration
github.com/usekaneo/kaneo
1---
2title: Authentication
3description: Learn how to authenticate API requests using API keys
4---
5
6
7All API endpoints require authentication using an API key. This guide explains how to create an API key and use it to authenticate your requests.
8
9## Creating an API Key
10
11<Steps>
12<Step>
13**Sign in to Kaneo**
14
15Sign in to your Kaneo instance using your account credentials.
16</Step>
17
18<Step>
19**Navigate to Settings**
20
21Go to your account settings by clicking on your profile or navigating to the Settings page.
22</Step>
23
24<Step>
25**Open the Account Tab**
26
27In the Settings page, click on the **Account** tab to view your account settings.
28</Step>
29
30<Step>
31**Access API Keys Section**
32
33Scroll down to the **API Keys** section in the Account tab. This section is located under the Developer Settings.
34</Step>
35
36<Step>
37**Create a New API Key**
38
39Click the **Create API Key** button to generate a new API key. You'll be prompted to provide a name for your API key to help you identify it later.
40</Step>
41
42<Step>
43**Save Your API Key**
44
45After creating the API key, you'll be shown the full API key value. **Copy and save this key immediately** - it will not be shown again for security reasons.
46
47<Warning>
48**Important**: Store your API key securely. If you lose it, you'll need to create a new one. The API key cannot be retrieved after creation.
49</Warning>
50</Step>
51</Steps>
52
53## Using Your API Key
54
55Once you have your API key, include it in the `Authorization` header of all API requests using the Bearer token format:
56
57```bash
58Authorization: Bearer your-api-key-here
59```
60
61### Example Request
62
63Here's an example of making an authenticated API request using curl:
64
65```bash
66curl -X GET https://your-kaneo-instance.com/api/task?workspaceId=your-workspace-id \
67 -H "Authorization: Bearer your-api-key-here" \
68 -H "Content-Type: application/json"
69```
70
71### Example with JavaScript
72
73```javascript
74const response = await fetch('https://your-kaneo-instance.com/api/task?workspaceId=your-workspace-id', {
75 method: 'GET',
76 headers: {
77 'Authorization': 'Bearer your-api-key-here',
78 'Content-Type': 'application/json'
79 }
80});
81```
82
83## Security Best Practices
84
85- **Keep your API keys secret**: Never commit API keys to version control or share them publicly
86- **Use descriptive names**: Name your API keys clearly so you can identify their purpose (e.g., "Production Script", "Development Testing")
87- **Rotate keys regularly**: Periodically create new API keys and revoke old ones
88- **Limit key scope**: Only grant API keys to trusted applications and services
89- **Monitor usage**: Regularly review your API keys and remove any that are no longer needed
90
91<Warning>
92If you suspect your API key has been compromised, immediately revoke it in the API Keys section and create a new one.
93</Warning>