Skip to content

Commit f7cd644

Browse files
committed
Remove some duplication and add screenshots
1 parent e1d5918 commit f7cd644

File tree

9 files changed

+61
-176
lines changed

9 files changed

+61
-176
lines changed

premium/api-keys.md

Lines changed: 22 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,54 @@
1-
# API Keys & Secrets
1+
# API Credentials
22

3-
rotki premium uses API Keys and Secrets to connect your subscription to the rotki application. This guide explains how to create, manage, and secure your API credentials.
3+
rotki premium uses API credentials to connect your subscription to the rotki application. This guide explains how to create, manage, and secure your API credentials.
44

5-
## What are rotki Premium API Keys?
5+
## What are rotki Premium API Credentials?
66

7-
API Keys and Secrets are authentication credentials that:
7+
The API Key and Secret are authentication credentials that:
88

99
- Link your rotki app to your premium subscription
1010
- Enable premium features in the application
1111
- Allow cloud backup and sync across devices
1212
- Identify your account for device limit management
1313

14-
## Creating API Keys
15-
16-
### First-Time Creation
14+
## Creating API Credentials
1715

1816
After purchasing a subscription, you need to manually generate your API credentials:
1917

2018
1. Go to your [subscription page](https://rotki.com/home/subscription)
21-
2. Navigate to the **API Keys** section
19+
2. Navigate to the **API Credentials** section
2220
3. Click the **Create** button
2321
4. Your credentials will be generated and displayed:
2422
- **API Key** - Your public identifier
2523
- **API Secret** - Your private authentication token
2624
5. You can view both credentials anytime from your subscription page
2725

2826
::: info Manual Generation Required
29-
API Keys and Secrets are not automatically created after payment. You must click the button to generate them for the first time.
27+
API Credentials are not automatically created after payment. You must click the button to generate them for the first time.
3028
:::
3129

32-
### Where to Find Existing Keys
33-
34-
You can view both your API Key and Secret anytime:
35-
36-
1. Visit your [subscription page](https://rotki.com/home/subscription)
37-
2. Look in the API Keys section
38-
3. Both your API Key and Secret will be displayed
39-
40-
## Using API Keys in the App
30+
## Using API Credentials in the App
4131

4232
After creating your API credentials, add them to rotki:
4333

4434
1. Open the rotki application
4535
2. Navigate to **API Keys****rotki Premium** in the sidebar
46-
3. Enter your **API Key**
47-
4. Enter your **API Secret**
48-
5. Click **Save**
36+
3. Enter your **API Key** and **API Secret**
37+
4. Click **Setup**
4938

50-
For detailed app setup instructions, see the [API Keys Usage Guide](/usage-guides/api-keys#rotki-premium).
39+
![Set up rotki premium API key/secret pair in an existing account](/images/rotki_premium_set.png)
5140

52-
## Managing API Keys
41+
## Managing API Credentials
5342

54-
### Viewing Your Keys
43+
### Viewing Your Credentials
5544

5645
From your [subscription page](https://rotki.com/home/subscription):
5746

5847
- Both your API Key and Secret are always visible
5948
- You can copy them anytime you need
6049
- You can see when the key was created
6150

62-
### Regenerating Keys
51+
### Regenerating Credentials
6352

6453
If you need to create new credentials:
6554

@@ -105,29 +94,11 @@ If you believe your API credentials have been exposed:
10594

10695
## API Keys and Device Limits
10796

108-
Each premium tier has a device limit. When you add your API credentials to rotki:
109-
110-
- The device is registered to your account
111-
- It counts toward your device limit
112-
- You can view and manage devices from the [devices page](/premium/devices)
113-
114-
### Checking Device Usage
115-
116-
From your [subscription page](https://rotki.com/home/subscription):
117-
118-
- View current device count
119-
- See your tier's device limit
120-
- Access the [device list](https://rotki.com/home/devices) for details
121-
122-
### Device Limit Exceeded
123-
124-
If you reach your device limit:
97+
Each premium tier has a device limit. Each rotki app account where you add your
98+
API credentials is registered as a new device and counts toward your device limit.
12599

126-
- New devices cannot authenticate
127-
- You'll see an error in the rotki app
128-
- Remove unused devices to free up slots
129-
130-
See [Device Management](/premium/devices) for details on managing devices.
100+
For more information about managing your devices, device limits, and what to do
101+
when you exceed your device limit, see the [Device Management](/premium/devices) documentation.
131102

132103
## Troubleshooting
133104

@@ -159,6 +130,10 @@ If premium features aren't activating:
159130
4. Try removing and re-adding the credentials
160131
5. Check the app logs for specific errors
161132

133+
When premium is successfully activated in the app you should see a `rotki Premium is active` banner in the rotki Premium view.
134+
135+
![Active rotki premium](/images/active_premium.png)
136+
162137
### Multiple Devices Not Syncing
163138

164139
If sync isn't working across devices:

premium/devices.md

Lines changed: 19 additions & 51 deletions
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,15 @@ Manage devices using your rotki premium subscription and understand device limit
44

55
## What are Device Limits?
66

7-
Each rotki premium tier includes a limit on how many devices can use the same API Key and Secret simultaneously. This prevents unauthorized sharing while allowing you to use rotki on multiple devices you own.
7+
Each rotki premium tier includes a limit on how many devices can use the same rotki API credentials simultaneously. This prevents unauthorized sharing while allowing you to use rotki on multiple devices you own.
88

99
Device limits vary by tier - check the [pricing page](https://rotki.com/pricing) for your tier's specific limit.
1010

11-
## Accessing Device Management
11+
## Viewing Your Devices
1212

1313
You can manage devices from two locations:
1414

15-
### Website (rotki.com)
16-
17-
Visit the [devices list page](https://rotki.com/home/devices) to manage devices online.
18-
19-
### rotki Application
20-
21-
Manage devices directly from the app:
22-
23-
1. Open rotki
24-
2. Go to **Settings****Account****Premium Devices**
25-
3. View and manage all registered devices
26-
27-
For detailed app instructions, see [Managing Premium Devices](/usage-guides/api-keys#managing-premium-devices).
28-
29-
## Viewing Your Devices
30-
31-
### On the Website
15+
**On the Website:**
3216

3317
From the [devices list page](https://rotki.com/home/devices), you can see:
3418

@@ -38,37 +22,33 @@ From the [devices list page](https://rotki.com/home/devices), you can see:
3822
- **Current count** - How many devices are active
3923
- **Your limit** - Maximum allowed for your tier
4024

41-
### In the App
25+
**In the App:**
4226

43-
From **Settings****Account****Premium Devices**:
27+
From **API Keys****rotki Premium**:
4428

4529
- View all devices using your API credentials
4630
- See active device count vs. your limit
4731
- Identify which device you're currently using
4832
- Access device management options
4933

50-
## Managing Device Names
51-
52-
### Editing Device Names
53-
54-
Device names help you identify which device is which (e.g., "Work Laptop", "Home Desktop", "MacBook Pro").
34+
![Premium devices management in the app](/images/premium_devices_app.png)
5535

56-
**On the Website:**
36+
For detailed app instructions, see [Managing Premium Devices](/usage-guides/api-keys#managing-premium-devices).
5737

58-
1. Go to the [devices list page](https://rotki.com/home/devices)
59-
2. Find the device you want to rename
60-
3. Click **Edit** or the edit icon
61-
4. Enter a new name
62-
5. Click **Save**
38+
## Editing Device Names
6339

64-
**In the App:**
40+
Device names help you identify which device is which (e.g., "Work Laptop", "Home Desktop", "MacBook Pro").
6541

66-
1. Go to **Settings****Account** **Premium Devices**
42+
1. Navigate to **API Keys****rotki Premium** in the sidebar of the App
6743
2. Find the device to rename
6844
3. Click the edit option
6945
4. Enter a new name
7046
5. Save changes
7147

48+
![Edit device name](/images/edit_device_name.png)
49+
50+
![Edit device name dialog](/images/edit_device_name_dialog.png)
51+
7252
::: tip Naming Strategy
7353
Use descriptive names to easily identify devices:
7454

@@ -122,7 +102,7 @@ If you try to use rotki on a new device after reaching your limit:
122102
- Premium features won't activate
123103
- The app may prompt you to manage devices
124104

125-
### Resolving Device Limit Issues
105+
### What to Do When You Exceed the Limit
126106

127107
To continue using rotki on a new device:
128108

@@ -146,11 +126,7 @@ For detailed troubleshooting, see the [Usage Guide](/usage-guides/api-keys#devic
146126

147127
### When is a Device Registered?
148128

149-
A device is registered when you:
150-
151-
1. Add rotki premium API credentials to the app
152-
2. Successfully authenticate
153-
3. The app connects to rotki servers
129+
A device is registered when you add rotki premium API credentials to the app and successfully authenticate with rotki servers.
154130

155131
### How Devices are Identified
156132

@@ -197,17 +173,9 @@ Avoid running rotki on multiple devices at the same time to prevent data sync co
197173

198174
To see your tier's device limit:
199175

200-
**Option 1: Subscription Page**
201-
202-
Visit your [subscription page](https://rotki.com/home/subscription) to see your current tier and limits.
203-
204-
**Option 2: Pricing Page**
205-
206-
Check the [pricing page](https://rotki.com/pricing) for device limits across all tiers.
207-
208-
**Option 3: Devices Page**
209-
210-
The [devices list page](https://rotki.com/home/devices) shows your current count and limit.
176+
- Visit your [subscription page](https://rotki.com/home/subscription) to see your current tier and limits.
177+
- Check the [devices list page](https://rotki.com/home/devices) to view a list of all your current devices.
178+
- Navigate to **API Keys****rotki Premium** in the app to see your limit and a list of your current devices.
211179

212180
## Troubleshooting
213181

premium/index.md

Lines changed: 11 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Premium Overview
22

3-
rotki premium is a paid subscription tier that unlocks additional features while supporting the ongoing development of rotki as an open-source project.
3+
rotki premium is a paid subscription with several tiers unlocking additional features depending on your needs while supporting the ongoing development of rotki as an open-source project.
44

55
## What is rotki Premium?
66

@@ -13,7 +13,7 @@ When you subscribe to rotki premium, you get:
1313
- Cloud backup and sync across multiple devices
1414
- Premium-only integrations (Monerium, Gnosis Pay, etc.)
1515
- Priority support
16-
- And more premium features
16+
- And more
1717

1818
To see the complete list of premium features and current pricing, visit [rotki.com/products](https://rotki.com/products/).
1919

@@ -33,28 +33,26 @@ See [Plans & Pricing](/premium/plans-and-pricing) for details.
3333

3434
Choose from three payment methods:
3535

36-
- **Crypto** - Manual transfer (non-renewable)
37-
- **Credit/Debit Card** - Auto-renewable via Braintree
36+
- **Crypto** - Manual transfer (renewal is done manually)
37+
- **Credit/Debit Card** - Auto-renewable
3838
- **PayPal** - Auto-renewable
3939

4040
See [Payment Process](/premium/payment) for step-by-step instructions.
4141

4242
### 3. Generate Your API Keys
4343

44-
After successful payment, you need to generate your API Key and Secret:
44+
After successful payment, generate your **API Key** and **API Secret**
45+
by clicking the **Create** button on your [subscription page](https://rotki.com/home/subscription).
4546

46-
1. Go to your [subscription page](https://rotki.com/home/subscription)
47-
2. Click the button to create/generate API credentials
48-
3. Your API Key and Secret will be displayed
49-
4. You can view both credentials anytime on this page
50-
51-
See [API Keys & Secrets](/premium/api-keys) for detailed instructions on creating and managing your keys.
47+
For detailed instructions, see [Creating API Keys](/premium/api-keys.html#creating-api-keys).
5248

5349
### 4. Add Keys to the App
5450

55-
Input your API Key and Secret into the rotki application to activate premium features.
51+
Navigate to **API Keys****rotki Premium** in the rotki application and enter the
52+
**API Key** and **API Secret** generated in the last step to activate the premium features
53+
included in your subscription.
5654

57-
For detailed instructions, see [API Keys in the Usage Guide](/usage-guides/api-keys#rotki-premium).
55+
For detailed instructions, see [Using API Keys in the App](/premium/api-keys.html#using-api-keys-in-the-app).
5856

5957
## Managing Your Premium Subscription
6058

premium/payment.md

Lines changed: 5 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -107,28 +107,16 @@ After completing payment:
107107
2. An invoice will be generated and available on your [subscription page](https://rotki.com/home/subscription)
108108
3. Your premium subscription is now active
109109

110-
## Step 5: Generate Your API Keys
110+
## Step 5: Activate your subscription in the App
111111

112-
After successful payment, you need to manually generate your API credentials:
112+
After successful payment, you need to manually generate your API credentials and
113+
add them to the rotki application.
113114

114-
1. Go to your [subscription page](https://rotki.com/home/subscription)
115-
2. Click the **Create** button
116-
3. Your API Key and Secret will be generated and displayed
117-
4. You can view both credentials anytime from your subscription page
115+
1. Create your API key via the [subscription page](https://rotki.com/home/subscription)
116+
2. Navigate to **API Keys****rotki Premium** in the app and enter your **API Key** and **API Secret**
118117

119118
See [API Keys & Secrets](/premium/api-keys) for detailed instructions.
120119

121-
## Step 6: Activate Premium in the App
122-
123-
Add your API credentials to the rotki application:
124-
125-
1. Open rotki
126-
2. Navigate to **API Keys****rotki Premium**
127-
3. Enter your API Key and Secret
128-
4. Click **Save**
129-
130-
See the [Usage Guide](/usage-guides/api-keys#rotki-premium) for detailed app setup instructions.
131-
132120
## Invoices and Receipts
133121

134122
All payment invoices are automatically generated and stored in your account.

premium/referrals.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,6 @@ You must have an active premium subscription to create and share referral codes.
1515

1616
## Creating a Referral Code
1717

18-
### Create Your Code
19-
2018
1. Go to your [subscription page](https://rotki.com/home/subscription)
2119
2. Navigate to the **Referral** section
2220
3. Click **Create**
@@ -25,8 +23,6 @@ You must have an active premium subscription to create and share referral codes.
2523

2624
## Using a Referral Code
2725

28-
### For New Subscribers
29-
3026
If someone shared a referral code with you:
3127

3228
1. Go to the [pricing page](https://rotki.com/pricing)
@@ -55,7 +51,6 @@ For referees:
5551
- 10% discount applies to first subscription only
5652
- One referral code per subscription
5753
- Cannot be combined with other promotions (unless specified)
58-
- Discount is forfeited if subscription is immediately canceled
5954

6055
## Troubleshooting
6156

public/images/active_premium.png

108 KB
Loading

public/images/edit_device_name.png

113 KB
Loading
28.9 KB
Loading

0 commit comments

Comments
 (0)