Skip to content

Commit 3594f2a

Browse files
committed
Add guide for creating an API key and update references across documentation
- Recommends using cli
1 parent d388749 commit 3594f2a

File tree

19 files changed

+61
-35
lines changed

19 files changed

+61
-35
lines changed
Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
---
2+
title: Create API Key
3+
---
4+
5+
# Create API Key
6+
7+
To use Pimlico's services, you'll need an API key. We recommend using our CLI for the quickest setup, but you can also use the dashboard.
8+
9+
## Using the CLI (Recommended)
10+
11+
The fastest way to get started is with our CLI tool. Run the following command from your project's root directory:
12+
13+
```bash
14+
pnpm dlx @pimlico/cli@latest
15+
```
16+
17+
This command will:
18+
- Interactively guide you through the setup process
19+
- Create your API key automatically
20+
- Add it to your `.env` file for immediate use
21+
22+
## Using the Dashboard
23+
24+
Alternatively, you can create an API key through our web dashboard:
25+
26+
1. Go to the [Pimlico Dashboard](https://dashboard.pimlico.io/)
27+
2. Sign up or log in to your account
28+
3. Click **API Keys** in the sidebar
29+
4. Click **Create API key**
30+
5. Copy your API key and add it to your project's `.env` file
31+
32+
:::tip
33+
Save your API key securely as you'll need it for all API requests. You can always retrieve it later from the [Dashboard](https://dashboard.pimlico.io/apikeys).
34+
:::
35+
36+
## Next Steps
37+
38+
Once you have your API key:
39+
- Add it to your `.env` file as `PIMLICO_API_KEY=your_key_here`
40+
- Start building with our [tutorials](/guides/tutorials/)
41+
- Explore our [developer resources](/references/)

docs/pages/guides/getting-started.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -73,9 +73,9 @@ Learn how to use Pimlico's ERC-20 paymaster to allow users to pay for their tran
7373

7474
[Start Tutorial 2 →](/references/permissionless/tutorial/tutorial-2)
7575

76-
## Getting a Pimlico API Key
76+
### Getting a Pimlico API Key
7777

78-
To use Pimlico's services, you'll need an API key. Visit our [dashboard](https://dashboard.pimlico.io) to create an account and generate your API key.
78+
To use Pimlico's services, you'll need an API key. [Learn how to create one](/guides/create-api-key)
7979

8080
## Understanding Account Abstraction
8181

docs/pages/guides/how-to/integrations/privy.mdx

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -22,23 +22,8 @@ Before starting, ensure you have:
2222

2323
:::::steps
2424
### Create an API key
25-
Generate a Pimlico API key to access our infrastructure. You have two options:
2625

27-
#### Using the CLI
28-
29-
```bash
30-
pnpm dlx @pimlico/cli@latest
31-
```
32-
33-
#### Using the Dashboard
34-
35-
1. Go to the [Pimlico Dashboard](https://dashboard.pimlico.io/)
36-
2. Click **API Keys** in the sidebar
37-
3. Click **Create API key**
38-
39-
:::tip
40-
Save your API key as you will need this in the next steps. You can always retrieve it later from the [Dashboard](https://dashboard.pimlico.io/apikeys).
41-
:::
26+
[Create your API key](/guides/create-api-key) to access our infrastructure.
4227

4328
### Enable Smart Wallets in the Privy Dashboard
4429
1. Navigate to your Privy Dashboard and locate the **Smart wallets** section in the left sidebar under **Wallet Infrastructure**.
@@ -54,7 +39,7 @@ You can either configure each chain manually or configure all chains in one go u
5439

5540
### Configure Chains
5641
1. Select Pimlico as the **Bundler and paymaster provider**.
57-
2. Enter your Pimlico API key. You can get your API key from our [Dashboard](https://dashboard.pimlico.io/apikeys).
42+
2. Enter your Pimlico API key. You can [create an API key here](/guides/create-api-key).
5843
3. Select the chains you want to configure. Pimlico supports all the chains on Privy (and more).
5944

6045
![Configure chains section](/privy-chain-configuration.png)

docs/pages/guides/tutorials/tutorial-1.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ You will set up the necessary permissionless.js clients, create a user operation
1010

1111
### Get a Pimlico API key
1212

13-
To get started, please go to our [dashboard](https://dashboard.pimlico.io) and generate a Pimlico API key.
13+
[Create your API key](/guides/create-api-key)
1414

1515
### Clone the Pimlico tutorial template repository
1616

docs/pages/guides/tutorials/tutorial-2.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ In this tutorial, you will deploy an ERC-4337 smart contract wallet on Base Sepo
1212

1313
### Get a Pimlico API key
1414

15-
To get started, please go to our [dashboard](https://dashboard.pimlico.io) and generate a Pimlico API key.
15+
[Create your API key](/guides/create-api-key)
1616

1717
### Clone the Pimlico tutorial template repository
1818

docs/pages/references/bundler/bundler-errors/invalid-api-key.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,4 @@
22

33
The API key you are trying to use is not valid. It either does not exist or has been deleted.
44

5-
You can find or generate an API key by going to our [dashboard](https://dashboard.pimlico.io).
5+
Learn how to [create an API key here](/guides/create-api-key).

docs/pages/references/bundler/public-endpoint.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ The public endpoint has the following rate limits:
3333
- **20 requests per minute per IP address**
3434

3535
:::tip[Need Higher Limits?]
36-
For production use or higher rate limits, please [create a Pimlico API key](https://dashboard.pimlico.io/apikeys) and use the authenticated endpoints.
36+
For production use or higher rate limits, please [create a Pimlico API key](/guides/create-api-key) and use the authenticated endpoints.
3737
:::
3838

3939
## Example Usage

docs/pages/references/bundler/usage.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ We recommend using [permissionless.js](/references/permissionless/reference/smar
66

77
ERC-4337 bundlers are relayers that bundle user operations into transactions and submit them to the blockchain. You can interact with bundlers using standard JSON-RPC requests.
88

9-
To get access to the bundler, you need to use your [Pimlico API key](https://dashboard.pimlico.io/apikeys). Using the API key, you can make the following JSON-RPC requests to the bundler:
9+
To get access to the bundler, you need to use your Pimlico API key. [Create one here](/guides/create-api-key) if you don't have one. Using the API key, you can make the following JSON-RPC requests to the bundler:
1010

1111
- [eth_sendUserOperation](/references/bundler/endpoints/eth_sendUserOperation)
1212
- [eth_estimateUserOperationGas](/references/bundler/endpoints/eth_estimateUserOperationGas)

docs/pages/references/flash-fund/how-to/eth-to-usdc-uniswap.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This guide demonstrates how to create a user operation that swaps ETH for USDC u
44

55
## Prerequisites
66

7-
- A Pimlico API key (get one from the [Pimlico Dashboard](https://dashboard.pimlico.io))
7+
- A Pimlico API key ([create one here](/guides/create-api-key))
88
- Basic understanding of Account Abstraction and ERC-4337
99
- Familiarity with TypeScript and Viem
1010
- Access to a network with Uniswap V3 deployed (we'll use Sepolia in this example)

docs/pages/references/flash-fund/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ Key features:
4949

5050
To start using FlashFund:
5151

52-
1. Get your Pimlico API key
52+
1. [Get your Pimlico API key](/guides/create-api-key)
5353
2. Choose your preferred mode (Credit or Resource Lock)
5454
3. For Credit mode:
5555
- Ask the Pimlico team to enable the FlashFund feature for your API key

0 commit comments

Comments
 (0)