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 benötigen eine Bearer-Authentifizierung über einen API-Schlüssel.

api_documentation.api_key_retrieve

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://click.eclick.app/api/{endpoint}' \
--header 'Authorization: Bearer {api_key}' \

api_documentation.errors.header

api_documentation.errors.subheader

Beispiel

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

api_documentation.status_codes

200 api_documentation.status_codes.200

400 api_documentation.status_codes.400

401 api_documentation.status_codes.401

404 api_documentation.status_codes.404

429 api_documentation.status_codes.429

500 api_documentation.status_codes.500

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

Benutzer

Links

Links-Statistiken

Pixel

Splash-Seiten

QR-Codes

Daten

Benachrichtigungs-Handler

Benutzerdefinierte Domains

Kontoprotokolle