> ## Documentation Index
> Fetch the complete documentation index at: https://docs.m1amdocs.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Key

An API key is required to make calls to the platform. In Partner Ecosystem Management, you can quickly and easily generate an API key.

Each API key is a JSON Web Token (JWT) that doesn't expire. For every API call a Reseller (Service Provider) makes to the MarketONE OpenAPIs, the API key must be included in the header (`X-API-KEY`) of the call to ensure a trusted communication. All communication is HTTP(s) based and supports SSL/TLS encryption.

<img src="https://mintcdn.com/amdocs-spbu/v6XW4z-1DbX5IGa9/marketONE/aggregatorAPIGuide/images/APIKeyAggregatorView.png?fit=max&auto=format&n=v6XW4z-1DbX5IGa9&q=85&s=e78f652600c6886d7a1c2d4557a0b24b" alt="API Key Page" width="1750" height="500" data-path="marketONE/aggregatorAPIGuide/images/APIKeyAggregatorView.png" />

* **[API Key Best Practices](apiKeyAggregator#api-key-best-practices)**

* **[Manage Your API Key](apiKeyAggregator#manage-your-api-key)**

* **[Example cURL API Key Usage](apiKeyAggregator#example-curl-api-key-usage)**

## API Key Best Practices

MarketONE recommends these best practices to keep your API key secure:

* Once you generate an API key, copy it and store in a safe location. Once the API key window is closed, the API key can no longer be retrieved for security purposes.
* Occasionally generate a new API key, update your applications with the new API key, and delete the old API key to ensure continuity of operations.

**Parent topic:**[API Key](apiKeyAggregator)

## Manage Your API Key

To integrate with the platform and make API calls, you must use an API key. This key is a JSON Web Token (JWT) that does not expire and is essential for secure communication.

Every API request made by a Reseller (Service Provider) must include the API key in the request header:

```
`X-API-KEY: your_api_key_here` 
```

In **Platform Settings** > **API Keys**, you can:

* Generate an API key
* Regenerate an API key

1. Navigate to **Platform Settings** > **API Key**.

   The **API Key** page appears.

   <img src="https://mintcdn.com/amdocs-spbu/v6XW4z-1DbX5IGa9/marketONE/aggregatorAPIGuide/images/APIKeyAggregatorView.png?fit=max&auto=format&n=v6XW4z-1DbX5IGa9&q=85&s=e78f652600c6886d7a1c2d4557a0b24b" alt="API Key Page" width="1750" height="500" data-path="marketONE/aggregatorAPIGuide/images/APIKeyAggregatorView.png" />

2. Select what you'd like to do:

   * To generate an API key, select the three dot menu and select **Generate New Key**.

     The **API Key Successfully Created** box appears.

     Select the API key in the field and press CTRL+C or select the **Copy** icon (<img src="https://mintcdn.com/amdocs-spbu/v6XW4z-1DbX5IGa9/marketONE/aggregatorAPIGuide/images/CopyIcon.png?fit=max&auto=format&n=v6XW4z-1DbX5IGa9&q=85&s=46d65140483b316178e50d366e756d2f" alt="Copy Icon" width="39" height="39" data-path="marketONE/aggregatorAPIGuide/images/CopyIcon.png" />) to copy it.

     When you're done, click **Close**.

     **Note:** Once you close the box, the API key can't be accessed again. This is to protect the key and ensure its security.

     <img src="https://mintcdn.com/amdocs-spbu/v6XW4z-1DbX5IGa9/marketONE/aggregatorAPIGuide/images/APIKeySuccessfullyCreated.png?fit=max&auto=format&n=v6XW4z-1DbX5IGa9&q=85&s=22da199abb910420971c4324004ca938" alt="API Key Successfully Created box" width="1084" height="578" data-path="marketONE/aggregatorAPIGuide/images/APIKeySuccessfullyCreated.png" />

   * To regenerate an API key, select **Regenerate Key**.

     The **Regenerate API Key** box appears.

     Select **Confirm Regeneration**.

     The **API Key Successfully Created** box appears.

     Select the API key in the field and press CTRL+C or select the **Copy** icon (<img src="https://mintcdn.com/amdocs-spbu/v6XW4z-1DbX5IGa9/marketONE/aggregatorAPIGuide/images/CopyIcon.png?fit=max&auto=format&n=v6XW4z-1DbX5IGa9&q=85&s=46d65140483b316178e50d366e756d2f" alt="Copy Icon" width="39" height="39" data-path="marketONE/aggregatorAPIGuide/images/CopyIcon.png" />) to copy it.

     When you're done, click **Close**.

     **Note:** Once you close the box, the API key can't be accessed again. This is to protect the key and ensure its security.

**Parent topic:**[API Key](apiKeyAggregator)

## Example cURL API Key Usage

```
POST /partnersub/v2/partnerSubscription HTTP/1.1
Host: plm-prodtest.m1amdocs.io
Content-Type: application/json
X-API-KEY: <<Insert API KEY here>>
Content-Length: 113
{
    "identifierType": "msisdn",
    "identifier": "4311211567",
    "plmCode": "GEI-PREM",
    "partnerCode": "GEI"
}
```

**Parent topic:**[API Key](apiKeyAggregator)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.