API Key

• API Key Best Practices
• Manage Your API Key
• Example cURL API Key Usage

​

API Key Best Practices

• 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.

​

Manage Your API Key

`X-API-KEY: your_api_key_here` 

• Generate an API key
• Regenerate an API key

1. Navigate to Platform Settings > API Key. The API Key page appears.
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 () 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.
   • 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 () 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.

​

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"
}