API-Dokumentation

Dies ist die Dokumentation für die verfügbaren API-Endpunkte, die auf der REST-Architektur basieren. Alle API-Endpunkte geben eine JSON-Antwort mit den standardmäßigen HTTP-Antwortcodes zurück und erfordern eine Bärenauthentifizierung über einen API-Schlüssel.

Holen Sie sich Ihren eigenen API-Schlüssel

Basis-URL

Authentifizierung

Alle API-Endpunkte erfordern einen API-Schlüssel, der mit der Bearer-Authentifizierungsmethode gesendet wird.

Authorization: Bearer {api_key}

Beispiel

curl --request GET \
--url 'https://profyler.de/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

Errors

Unsere API verwendet herkömmliche HTTP-Statuscodes, um den Erfolg oder Misserfolg einer Anfrage anzuzeigen.

Beispiel

{
    "errors": [
        {
            "title": "Du hast keinen Zugriff auf die API.",
            "status": 401
        }
    ]
}

Statuscodes

200 Anfrage erfolgreich abgeschlossen

400 Ungültige Anfrage - Erforderliche Parameter fehlen oder sind ungültig

401 Nicht autorisiert - API-Schlüssel fehlt oder ist ungültig

404 Die angeforderte Ressource wurde nicht gefunden

429 Zu viele Anfragen - Ratenlimit überschritten

500 Interner Serverfehler - das bedeutet, dass es ein Problem auf unserer Seite gibt

Alle API-Endpunktergebnisse funktionieren mit der UTC Zeitzone, sofern nicht anders angegeben.

Benutzer

Links

Link-Statistiken

Projekt

Pixel

Splash-Seiten

QR Code

Mail-Signatur

Daten

Alarme

Eigene Domains

Meine Teams

Teammitglieder

Teammitglied

Kontozahlungen

Account Logs