Skip to content

ApoAlly API#

Configuration#

Configuring the ApoAlly API is an essential step to successfully integrate the API into your systems. Below, you will find a detailed guide on setting up and using the API.

API Key#

The API key is required to access the ApoAlly API. Follow these steps to set your key:

  1. Obtain API Key: Request your individual API key through the ApoAlly customer portal or contact support at support@apoally.de.
  2. Store Key: Securely store the received API key in your application or configuration management system.
  3. Use Key: Add the API key to the header of your API requests, as shown in the following example:
Authorization: Bearer YOUR_API_KEY

API Endpoints#

The ApoAlly API offers different endpoints depending on the selected plan. Replace 12345678912345 with your individual API ID, which you will receive after registration.

  • ApoAlly Basic:
    Endpoint: https://api.apoally.de/api

  • ApoAlly Pro:
    Endpoint: https://12345678912345.apoally.de/api

Example Configuration#

Here is an example of how to configure the API in your application:

Python#

import requests

api_url = "https://12345678912345.apoally.de/api"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json"
}

response = requests.get(api_url, headers=headers)
print(response.json())

PowerShell#

$apiUrl = "https://12345678912345.apoally.de/api"
$headers = @{
    "Authorization" = "Bearer YOUR_API_KEY"
    "Content-Type" = "application/json"
}

$response = Invoke-RestMethod -Uri $apiUrl -Headers $headers -Method Get
$response

Security Notes#

  • Keep Key Confidential: Do not share your API key with third parties.
  • Restrict Access Rights: Use role-based access control to manage API usage.
  • Use HTTPS: Ensure all requests are made over HTTPS to secure data transmission.

With these configuration steps, you can seamlessly integrate the ApoAlly API into your systems and make optimal use of its features.