> For the complete documentation index, see [llms.txt](https://api.senderwiz.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://api.senderwiz.com/api-url-and-key.md).

# API URL and Key

This guide explains how customers and administrators can locate their respective API URLs and generate API keys to start integrating with the SenderWiz platform.

### 🔑 Accessing Your API URL and Key

To integrate with SenderWiz, you'll need your unique **API URL** and **API key**. 

These are available separately for both **Customer** and **Admin** panels.

***

### 👤 Customer Panel

#### Step 1: Go to API Section

* Login to your **Customer Account**
* Click on your name or profile in the top-right corner
* From the dropdown, select **API**

![Uploaded image](https://files.oaiusercontent.com/file-C4uZ1T4WwjJHn47P6NBzPM?se=2025-04-18T09%3A34%3A32Z\&sp=r\&sv=2024-08-04\&sr=b\&rscc=max-age%3D299%2C%20immutable%2C%20private\&rscd=attachment%3B%20filename%3D4aa7bb61-852b-41e2-bf60-328ee595dd9a.png\&sig=VV%2BpbN4puDt7hVeAoAkuoKhXXWiABc79RzaGkTEE4LQ%3D)

***

#### Step 2: View API URL

* Once in the API section, click the **info** icon (`ℹ️`)

<figure><img src="https://1730241710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtOuXgNekTBraFWS69SKF%2Fuploads%2FTAilbsZTg062ZXNMYAMH%2Fimage.png?alt=media&amp;token=92a55bfb-fd13-4785-acdb-63372d749629" alt=""><figcaption></figcaption></figure>

* A pop-up will show your API base URL\
  📌 Example: `https://app.senderwizpro.com/api`

<figure><img src="https://1730241710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtOuXgNekTBraFWS69SKF%2Fuploads%2FHRUow8XsEaXpmFvMSk3v%2Fimage.png?alt=media&amp;token=6cf9c728-1756-489c-8fe3-7883b956353b" alt="" width="563"><figcaption></figcaption></figure>

***

#### Step 3: Create API Key

* Click the **Create new** button

<div align="left"><figure><img src="https://1730241710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtOuXgNekTBraFWS69SKF%2Fuploads%2FU898tN71F0B2N972r9Eb%2Fimage.png?alt=media&amp;token=71306faa-e44b-453e-bcd6-c5f074836419" alt="" width="281"><figcaption></figcaption></figure></div>

* Your API key will be instantly generated
* You can add optional fields like:
  * **Name** (to label the key)
  * **IP Whitelist**
  * **IP Blacklist**

<figure><img src="https://1730241710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtOuXgNekTBraFWS69SKF%2Fuploads%2FN5K6oHzM5IKQMmVWsa3j%2Fimage.png?alt=media&amp;token=31d75fae-38a0-43c0-9fd6-774b8951202e" alt=""><figcaption></figcaption></figure>

* After entering the optional fields, click **Save changes**

***

### 🛠️ Admin Panel

The process for Admin is similar to the Customer panel but is accessible only via the **Admin Dashboard**. The Admin will have separate keys and API endpoint URLs.

{% hint style="warning" %}
Please ensure that you do not share your API key publicly. Treat it like a password.
{% endhint %}

#### Step 1: Go to API Section

* Login to your **Admin Account**
* Click on your name or profile in the top-right corner
* From the dropdown, select **API**

***

#### Step 2: View API URL

* Once in the API section, click the **info** icon (`ℹ️`)

<figure><img src="https://1730241710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtOuXgNekTBraFWS69SKF%2Fuploads%2FIXcTD3mXMwQDfih2GUVZ%2Fimage.png?alt=media&amp;token=7ea513b4-f308-4d1f-a277-58735f16a724" alt=""><figcaption></figcaption></figure>

* A pop-up will show your API base URL\
  📌 Example: `https://app.senderwizpro.com/api/admin`

<figure><img src="https://1730241710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtOuXgNekTBraFWS69SKF%2Fuploads%2F5r5ML2Z6L2alk52g2pxX%2Fimage.png?alt=media&amp;token=ef16cb5c-e8cc-4706-96f1-b905f5e20b55" alt=""><figcaption></figcaption></figure>

***

#### Step 3: Create API Key

* Click the **Create new** button

<div align="left"><figure><img src="https://1730241710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtOuXgNekTBraFWS69SKF%2Fuploads%2F7WGF6UGR2DwFSnAJDx3y%2Fimage.png?alt=media&amp;token=5edc0cfb-a693-4763-ba98-10de0f7d940e" alt="" width="375"><figcaption></figcaption></figure></div>

* Your API key will be instantly generated
* You can add optional fields like:
  * **Name** (to label the key)
  * **IP Whitelist**
  * **IP Blacklist**

<figure><img src="https://1730241710-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FtOuXgNekTBraFWS69SKF%2Fuploads%2FLpCHiYvety1KNuOKWadT%2Fimage.png?alt=media&amp;token=71a0e2b6-365c-44b1-a69a-cbd7e9f66f8e" alt=""><figcaption></figcaption></figure>

* After entering the optional fields, click **Save changes**

***

### Final Notes

* Use the generated API key in your integration headers or parameters.
* Always whitelist trusted IPs when setting up your API key for added security.
* You can manage, regenerate, or revoke API keys anytime from the same section.

***