Skip to content

Commit 27b3d64

Browse files
committed
added API key docs
1 parent 82e8513 commit 27b3d64

File tree

13 files changed

+45
-83
lines changed

13 files changed

+45
-83
lines changed
687 KB
Loading
Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
import { DocImage, Steps, Step } from "@doc";
2-
import chooseKeyImage from "../assets/choose-key.png";
32
import allowedDomainsImage from "../assets/allowed-domains.png";
4-
import selectEditImage from "../assets/select-edit.png";
53
import { createMetadata } from "@doc";
4+
import AccessRestrictions from "./assets/access-restrictions.png";
5+
import ProjectOverview from "../assets/project-overview.png";
66

77
export const metadata = createMetadata({
88
title: "Access Restrictions",
@@ -24,32 +24,28 @@ To modify the allowed Domain Id or Bundle Ids:
2424

2525
<Steps>
2626

27-
<Step title="Go to Dashboard">
27+
<Steps>
2828

29-
Go to **[thirdweb dashboard](https://thirdweb.com/team)**
29+
<Step title="Select Project">
3030

31-
</Step>
31+
Select the project you want to set access restrictions on from the Overview section of your dashboard.
3232

33-
<Step title="Choose API Key">
34-
Choose the API Key you want to modify restrictions on.
33+
<DocImage src={ProjectOverview} alt="Project Overview" />
3534

36-
<DocImage src={chooseKeyImage} />
3735
</Step>
3836

39-
<Step title="Edit">
40-
Select `Edit` to enter editor mode.
37+
<Step title="Project Settings">
4138

42-
<DocImage src={selectEditImage} />
43-
</Step>
39+
Navigate to the project's settings and locate Domain Restrictions and Bundle ID restrictions. Add the domain or bundle id you want to restrict the project on.
4440

45-
<Step title="Edit Domains">
46-
Enter the allowed domains the "Allowed Domains" field or switch to Bundle IDs to enter allowed Bundle IDs.
41+
<DocImage src={AccessRestrictions} alt="" />
4742

48-
<DocImage src={allowedDomainsImage} />
4943
</Step>
5044

5145
<Step title="Save Changes">
52-
46+
Save your changes to apply the access restrictions.
5347
</Step>
5448

5549
</Steps>
50+
51+
</Steps>
-556 KB
Binary file not shown.
9.75 KB
Loading
568 KB
Loading
-594 KB
Binary file not shown.
461 KB
Loading
Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
import { DocImage, Steps, Step } from "@doc";
2-
import chooseKeyImage from "../assets/choose-key.png";
32
import confirmDeleteImage from "../assets/confirm-delete.png";
3+
import ProjectOverview from "../assets/project-overview.png";
4+
import DeleteProject from "./assets/delete-project.png";
45
import { createMetadata } from "@doc";
56

67
export const metadata = createMetadata({
@@ -13,27 +14,30 @@ export const metadata = createMetadata({
1314
},
1415
});
1516

16-
# Delete API Key
17+
# Delete Or Transfer Project
1718

18-
Deleting an API key will invalidate it, making it no longer usable.
19+
Deleting a project also removes its associated API key, rendering it invalid and unusable. You may also choose to transfer projects to another team.
1920

2021
<Steps>
2122

22-
<Step title="Go to Dashboard">
23-
Go to **[your team's projects page](https://thirdweb.com/team)** on the dashboard.
24-
</Step>
23+
<Step title="Select Project">
2524

26-
<Step title='Choose API Key'>
27-
Choose the API Key you want to delete.
25+
Select the project you want to delete or transfer from the Overview section of your dashboard.
2826

29-
<DocImage src={chooseKeyImage} />
27+
<DocImage src={ProjectOverview} alt="Project Overview" />
3028

3129
</Step>
3230

33-
<Step title='Delete Key'>
34-
To delete an API key, select `Delete key` and confirm your intention to delete the key. The key will then be deleted.
31+
<Step title="Project Settings">
32+
33+
Navigate to the project's settings and locate "Transfer Project" or "Delete Project".
34+
35+
<DocImage src={DeleteProject} alt="Delete Project" />
36+
37+
</Step>
3538

36-
<DocImage src={confirmDeleteImage} />
39+
<Step title="Confirm Transfer or Deletion">
40+
In the UI confirm the transfer or deletion of the project.
3741
</Step>
3842

3943
</Steps>
306 KB
Loading
Lines changed: 14 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
import { DocImage, Steps, Step } from "@doc";
2-
import chooseKeyImage from "../assets/choose-key.png";
3-
import selectEditImage from "../assets/select-edit.png";
4-
import allServicesImage from "../assets/all-services.png";
2+
import ProjectOverview from '../assets/project-overview.png';
3+
import EnabledServices from './assets/enabled-services.png';
54
import { createMetadata } from "@doc";
65

76
export const metadata = createMetadata({
@@ -14,70 +13,33 @@ export const metadata = createMetadata({
1413
},
1514
});
1615

17-
# Edit enabled services on API Keys
16+
# Enabled Services
1817

19-
All services on API keys are enabled by default. If you want to disable any services or edit settings for each service:
2018

21-
<Steps>
22-
23-
<Step title="Project Settings">
2419

25-
Navigate to the project settings of your dashboard.
20+
All services on API keys per project are enabled by default. If you want to disable any services or edit settings for each service:
2621

27-
</Step>
22+
<Steps>
2823

29-
<Step title="Choose API key">
24+
<Step title="Select Project">
3025

31-
Choose the API Key from which you want to enable or disable a Service.
26+
Select the project you want to edit services for from the Overview section of your dashboard.
3227

33-
<DocImage src={chooseKeyImage} />
28+
<DocImage src={ProjectOverview} alt="Project Overview" />
3429

3530
</Step>
3631

37-
<Step title="Edit">
38-
Select `Edit` to enter the editor view.
32+
<Step title="Project Settings">
3933

40-
<DocImage src={selectEditImage} />
41-
</Step>
34+
Navigate to the project's settings and locate "Enabled Services".
4235

43-
<Step title="Modify services">
44-
Navigate to the Services section and enable the service and modify any services as needed.
36+
<DocImage src={EnabledServices} alt="Enabled Services" />
4537

46-
<DocImage src={allServicesImage} />
4738
</Step>
4839

49-
<Step title="Save Changes">
40+
<Step title="Modify Services">
41+
Toggle the specified service you want on or off. Each service is on by default and toggling will turn off access to the service for the project.
5042
</Step>
51-
</Steps>
52-
53-
### Services
54-
55-
#### Storage
56-
57-
By default, Storage services are enabled upon creation of the API Key.
5843

59-
Storage provides two sub-settings enabled by default on API Key creation.
60-
61-
- Upload - Enable uploading to Storage
62-
- Download - Enable downloading from Storage
63-
64-
To disable Upload or Download:
65-
66-
1. Navigate to Settings > API Keys
67-
2. Toggle the checkboxes in the Services > Storage settings
68-
69-
#### RPC Edge
70-
71-
By default, RPC Edge services are enabled upon creation of the API Key.
72-
73-
To use RPC Edge in your application, see our [RPC Edge QuickStart](/infrastructure/rpc-edge/get-started) article.
74-
75-
#### Account abstraction services
76-
77-
By default, Account abstraction services services are enabled upon creation of the API Key.
78-
79-
To set additional rules on which transactions you want to sponsor, go to your Team > Project > Account Abstraction > Configuration page.
80-
81-
#### In-App Wallets
44+
</Steps>
8245

83-
By default, In-App Wallet services are enabled upon creation of the API Key. You can view your in-app wallet's settings in your Team > Project > Connect > In App Wallets page.

0 commit comments

Comments
 (0)