Subscription keys are unique identifiers used to manage and monitor API access. They help enforce rate limits and enhance security in 3E cloud.

Implementing subscription keys allows Elite to:

• Improve API access control and monitoring, ensuring greater stability and security
• Provide enhanced levels of rate limits through additional subscriptions

All applications using 3E APIs must integrate subscription keys into their requests.

Note: eBillingHub currently does not require subscription keys.

Subscription keys must be included in the request header or as a query parameter (See example below). If a key is missing or invalid, the API request will be rejected once the requirement is enforced.

Requesting Subscription Keys

To request subscription keys, you need to create a support ticket and provide some required information.

Do the following to request a subscription key:

1. Open a ticket with Elite Support to request a new subscription key.
2. Provide the following Required Information:

• Registered Application Name
• Client ID associated with the App Registration in the customer’s Entra ID

Elite will generate and provide the subscription keys linked to the specified Client ID.

How to Implement Subscription Keys

Applications calling 3E APIs must be updated to include the issued subscription key as a header parameter.

Sample cURL Request:

curl --location 'https://api.elite.com/3e/odata/Matter?$top=10' \

--header 'X-3E-InstanceId: syeg9ourakkzeucus9o8fg' \

--header 'x-subscription-key: 0348240e1aa947ea9b69241be0315384' \

--header 'Authorization: Bearer <bearer_token>'

In this example, the x-subscription-key header must be populated with the assigned subscription key. Requests without a valid subscription key will be rejected once subscription keys become mandatory.