Ga naar inhoud

ApoAlly API#

Configuratie#

De configuratie van de ApoAlly API is een essentiële stap om de API succesvol in uw systemen te integreren. Hieronder vindt u een gedetailleerde handleiding voor het instellen en gebruiken van de API.

API Sleutel#

De API-sleutel is vereist om toegang te krijgen tot de ApoAlly API. Volg deze stappen om uw sleutel in te stellen:

  1. API-sleutel verkrijgen: Vraag uw persoonlijke API-sleutel aan via het ApoAlly-klantenportaal of neem contact op met de support via support@apoally.de.
  2. Sleutel opslaan: Sla de verkregen API-sleutel veilig op in uw applicatie of configuratiemanagementsysteem.
  3. Sleutel gebruiken: Voeg de API-sleutel toe aan de header van uw API-verzoeken, zoals in het volgende voorbeeld:
Authorization: Bearer YOUR_API_KEY

API Eindpunten#

De ApoAlly API biedt verschillende eindpunten, afhankelijk van het gekozen abonnement. Vervang 12345678912345 door uw persoonlijke API-ID, die u ontvangt na registratie.

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

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

Voorbeeldconfiguratie#

Hier is een voorbeeld van hoe u de API in uw applicatie kunt configureren:

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

Beveiligingsrichtlijnen#

  • Houd de sleutel geheim: Deel uw API-sleutel niet met derden.
  • Beperk toegangsrechten: Gebruik op rollen gebaseerde toegangsrechten om het gebruik van de API te controleren.
  • Gebruik HTTPS: Zorg ervoor dat alle verzoeken via HTTPS worden uitgevoerd om de veiligheid van de gegevensoverdracht te waarborgen.

Met deze configuratiestappen kunt u de ApoAlly API naadloos in uw systemen integreren en optimaal gebruikmaken van de functionaliteiten.