Dokumentation

Entwicklerdokumentation und Integrationsleitfäden

Alles, was Sie brauchen, um Valqor in Ihren Stack zu integrieren.

Erste Schritte

Erstellen Sie Ihren ersten Branded Link, richten Sie eine eigene Domain ein und entdecken Sie das Dashboard.

  1. Registrieren Sie sich und erstellen Sie Ihren Workspace
  2. Fügen Sie unter Dashboard → Domains eine eigene Domain hinzu
  3. Erstellen Sie Ihren ersten Link mit einem Marken-Slug
  4. Sehen Sie Echtzeit-Analysen in Ihrem Dashboard

API-Referenz

REST API für Links, Domains, Analysen und die Verwaltung von API-Schlüsseln mit eingeschränkten Berechtigungen.

Authentifizierung

Erstellen Sie unter Dashboard → API-Schlüssel einen API-Schlüssel. Übergeben Sie ihn als Bearer-Token:

Authorization: Bearer vq_your_key_here

Integrationen

Verbinden Sie Valqor mit Ihrem CRM, Ihren CI/CD-Pipelines, Marketing-Plattformen und Analyse-Tools.

  • Webhooks — Ereignisbenachrichtigungen in Echtzeit (nur HTTPS)
  • CSV-Import/-Export — Massenverwaltung von Links
  • Conversion-Tracking — Pixelbasierte Attribution
  • GA4 — Automatisches Tagging mit UTM-Parametern

REST API

API-Endpunkte

Basis-URL: https://valqor.app

POST/api/links

Erstellt einen neuen Markenlink

Beispiel
curl -X POST https://valqor.app/api/links \
  -H "Authorization: Bearer vq_..." \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "go.example.com",
    "slug": "launch",
    "destination": "https://example.com/product",
    "tags": ["marketing", "launch-2025"]
  }'
GET/api/links

Listet alle Links in Ihrem Workspace auf

Beispiel
curl https://valqor.app/api/links \
  -H "Authorization: Bearer vq_..."
PATCH/api/links/:id

Aktualisiert einen vorhandenen Link

Beispiel
curl -X PATCH https://valqor.app/api/links/lnk_abc123 \
  -H "Authorization: Bearer vq_..." \
  -H "Content-Type: application/json" \
  -d '{ "destination": "https://example.com/new-page" }'
DELETE/api/links/:id

Löscht einen Link dauerhaft

Beispiel
curl -X DELETE https://valqor.app/api/links/lnk_abc123 \
  -H "Authorization: Bearer vq_..."
GET/api/analytics

Ruft Analysedaten zu Ihren Links ab

Beispiel
curl "https://valqor.app/api/analytics?period=30d" \
  -H "Authorization: Bearer vq_..."
GET/api/domains

Listet die konfigurierten eigenen Domains auf

Beispiel
curl https://valqor.app/api/domains \
  -H "Authorization: Bearer vq_..."

Limits

Ratenbegrenzung

API-Ratenlimits gelten pro API-Schlüssel und werden über ein gleitendes Zeitfenster durchgesetzt.

Free60 req/min
Pro600 req/min
Business6 000 req/min

Konventionen

Antwortformat

Erfolg

{
  "item": { "id": "lnk_abc123", "slug": "launch", ... }
}

Fehler

{
  "error": "Slug is already taken",
  "code": "SLUG_COLLISION"
}