API Key Generation and Usage

@if (apiKey) {
API Key Details

Created on: {{ apiKey.createdOn | date: 'dd.MM.yyyy HH:mm' }}

Created by: {{ apiKey.createdBy }}

@if (apiKey.modifiedBy) {

Last updated on: {{ apiKey.modifiedOn | date: 'dd.MM.yyyy HH:mm' }}

Last updated by: {{ apiKey.modifiedBy }}

}
} @else {
No API Key Available

You have not created an API Key yet. Click the button below to generate one.

}

How to Use the API Key

You can send the API Key in two ways:

  • As a URL Query Parameter: Add the key parameter to your URL.
  • As a Request Header: Include the API Key in the X-Api-Key header.
Examples
https://api.example.com/data?key=YOUR_API_KEY&allianceId=YOUR_ALLIANCE_ID
curl -X GET "https://api.example.com/data?key=YOUR_API_KEY&allianceId=12345"

In both cases, make sure to include your AllianceId as a query parameter to ensure correct access and data retrieval.

Swagger Documentation

To explore all available API endpoints and their detailed usage, check out our Swagger documentation here.