API

Sie können alle Funktionen unseres Portals auch per API bedienen und automatisieren.

Authorisierung

Ihren API-Key erhalten Sie in Ihrem Profil unter dem Reiter "API Keys". Sofern das Feld API Key noch leer ist, klicken Sie unter dem jeweiligen Mandanten auf das -Symbol und anschließend auf "Key Erzeugen". Kopieren Sie den angelegten API-Key anschließend in die Zwischenablage.

Zur Authentifizierung nutzen Sie den "Authorization"-Header mit dem Inhalt "Token "

Python3 Beispiel

#!/usr/bin/env python3
import requests
import os

API_KEY = os.getenv("API_KEY")
BASE_URL = "http://edgeportal.edgeops.de/api"
API_VERSION = "v1"

def main() -> None:
    me = get_me()
    print(f"Hello, {me['first_name']} {me['last_name']}")

def get_me() -> dict:
    return api_get(application="multi-tenancy", endpoint="user/me")

def get_api_url(application:str, endpoint:str) -> str:
    return f"{BASE_URL}/{application}/{API_VERSION}/{endpoint}"

def api_get(application:str, endpoint:str) -> dict:
    headers = {
        "Authorization": f"Token {API_KEY}"
    }
    url = get_api_url(application=application, endpoint=endpoint)
    response = requests.get(url, headers=headers)
    return response.json()

if __name__ == "__main__":
    main()

API-Dokumentation

Eine vollständige und interaktive Dokumentation aller API-Endpunkte finden Sie hier.