Zum Inhalt

ApoAlly API#

Konfiguration#

Die Konfiguration der ApoAlly API ist ein essenzieller Schritt, um die API erfolgreich in Ihre Systeme zu integrieren. Nachfolgend finden Sie eine detaillierte Anleitung zur Einrichtung und Nutzung der API.

API Schlüssel#

Der API-Schlüssel ist erforderlich, um auf die ApoAlly API zuzugreifen. Folgen Sie diesen Schritten, um Ihren Schlüssel zu setzen:

  1. API-Schlüssel erhalten: Beantragen Sie Ihren individuellen API-Schlüssel über das ApoAlly-Kundenportal oder kontaktieren Sie den Support unter support@apoally.de.
  2. Schlüssel speichern: Speichern Sie den erhaltenen API-Schlüssel sicher in Ihrer Applikation oder Ihrem Konfigurationsmanagement.
  3. Schlüssel verwenden: Fügen Sie den API-Schlüssel in den Header Ihrer API-Anfragen ein, wie im folgenden Beispiel gezeigt:
Authorization: Bearer YOUR_API_KEY

API Endpunkte#

Die ApoAlly API bietet unterschiedliche Endpunkte, je nach gewähltem Plan. Ersetzen Sie 12345678912345 mit Ihrer individuellen API-ID, die Sie nach der Registrierung erhalten.

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

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

Beispielkonfiguration#

Hier ist ein Beispiel, wie Sie die API in Ihrer Anwendung konfigurieren können:

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

Sicherheitshinweise#

  • Schlüssel geheim halten: Teilen Sie Ihren API-Schlüssel nicht mit Dritten.
  • Zugriffsrechte einschränken: Verwenden Sie rollenbasierte Zugriffsrechte, um die Nutzung der API zu kontrollieren.
  • HTTPS verwenden: Stellen Sie sicher, dass alle Anfragen über HTTPS erfolgen, um die Sicherheit der Datenübertragung zu gewährleisten.

Mit diesen Konfigurationsschritten können Sie die ApoAlly API nahtlos in Ihre Systeme integrieren und deren Funktionen optimal nutzen.