Alle Endpunkte, die du mit einem API-Key nutzen kannst – nach Bereich sortiert, mit Methode, Pfad, benötigtem Scope und Zweck.

Diese Übersicht listet alle Endpunkte, die mit einem Token aus einem API-Key funktionieren. Alle Pfade beginnen mit https://dock.at-harbor.com. Die genauen Felder jedes Endpunkts stehen in der OpenAPI-Beschreibung unter https://dock.at-harbor.com/openapi.yaml.

Anmeldung und öffentliche Endpunkte

Methode und Pfad	Anmeldung	Zweck
POST /v1/token	Keine (Key-ID und Secret im Body)	API-Key gegen Access-Token tauschen
GET /v1/plans	Keine	Pläne und Preise
GET /v1/pages/available?handle=…	Keine	Prüfen, ob ein Handle frei ist

Pages

Methode und Pfad	Scope	Zweck
GET /v1/pages	read:pages	Alle Pages des Workspaces mit ID, Handle, Titel, Status, Live-Version, Sichtbarkeit und URL
POST /v1/pages	write:pages	Page anlegen; Pflicht: handle (2–64 Zeichen, Buchstaben, Ziffern, Bindestrich) und template_key; optional title, domain_id, theme_config
GET /v1/pages/{id}	read:pages	Eine Page; zusätzlich has_unpublished_changes (true, wenn der Entwurf vom veröffentlichten Stand abweicht)
PATCH /v1/pages/{id}	write:pages	title, handle oder discoverable (Eintrag im Verzeichnis) ändern
PATCH /v1/pages/{id}/visibility	write:pages	public, private oder password (mit password, 4–72 Zeichen); wirkt sofort
POST /v1/pages/{id}/publish	write:pages	Entwurf veröffentlichen; Antwort enthält die neue Version
GET /v1/pages/{id}/versions	read:pages	Veröffentlichte Versionen
GET /v1/pages/{id}/versions/{version}	read:pages	Eine Version
POST /v1/pages/{id}/versions/{version}/restore	write:pages	Version in den Entwurf holen; current verwirft alle Entwurfsänderungen
GET /v1/pages/{id}/seo	read:pages	SEO- und Teilen-Texte
PATCH /v1/pages/{id}/seo	write:pages	seo_title, seo_description, og_title, og_description, og_image_asset_id, canonical_url, noindex
POST /v1/pages/{id}/invite-link	write:pages	Einladungslink für eine private, veröffentlichte Page; days 1–30, Standard 7. Sonst 409 page_not_private bzw. page_not_published
POST /v1/pages/{id}/invite-link/revoke	write:pages	Einladungslink widerrufen
POST /v1/pages/{id}/uploads	write:assets	Datei für eine Page hochladen

Entwurf

Methode und Pfad	Scope	Zweck
GET /v1/pages/{id}/draft	read:pages	Aktueller Entwurf: template_key, config, theme_config, custom_css, seo, Bild-Zuordnungen und Links
PATCH /v1/pages/{id}/draft	write:pages	Mindestens eines von config (als JSON höchstens 64 KB, je Text bis 5.000 Zeichen), theme_config, custom_css (bis 50.000 Zeichen und 65.535 Bytes), seo, template_key, template_asset_bindings
GET /v1/pages/{id}/draft/validate	read:pages	Prüfen, ob der Entwurf veröffentlicht werden kann

Blöcke

Methode und Pfad	Scope	Zweck
GET /v1/pages/{id}/blocks	read:pages	Blöcke der Page
POST /v1/pages/{id}/blocks	write:pages	Block anlegen; Pflicht: type und config
PATCH /v1/pages/{id}/blocks/{blockId}	write:pages	Block ändern
DELETE /v1/pages/{id}/blocks/{blockId}	write:pages	Block löschen
POST /v1/pages/{id}/blocks/reorder	write:pages	Reihenfolge setzen
GET /v1/blocks/schemas	read:pages	Alle Blocktypen mit dem Schema ihrer config

Anlegbare Typen: text, image, embed, spacer, social_links, form, integration, donation, modal, heading, notice, coupon, contact, opening_hours, tour, file, vcard, countdown und gallery. Der Links-Block ist fest und wird nicht über diesen Endpunkt angelegt. Blocktypen außerhalb deines Plans lehnt die API mit 403 block_type_requires_plan ab. Die config eines Blocks darf als JSON höchstens 128 KB groß sein, jeder Text darin höchstens 10.000 Zeichen; beim Info-Modal darf modal_body_html bis zu 50.000 Zeichen und höchstens 65.535 Bytes haben.

Links

Methode und Pfad	Scope	Zweck
GET /v1/pages/{id}/links	read:links	Links der Page
POST /v1/pages/{id}/links	write:links	Link anlegen; Pflicht: title (1–200) und target_url_template (8–2048)
GET /v1/pages/{id}/links/{linkId}	read:links	Ein Link
PATCH /v1/pages/{id}/links/{linkId}	write:links	Link ändern
DELETE /v1/pages/{id}/links/{linkId}	write:links	Link löschen
POST /v1/pages/{id}/links/reorder	write:links	Reihenfolge setzen: {"order":[IDs]}

Optionale Felder beim Anlegen und Ändern: enabled, geo (Länderregel mit mode allowlist oder denylist und countries), device (eigene Ziele je Gerät), starts_at und ends_at (Zeitsteuerung), protection_tier (Bot-Schutz) und age_restriction. Zeitsteuerung, Länder- und Geräteregeln gibt es ab Creator Pro. Beim Sortieren reicht es, die IDs zu schicken, die nach vorne sollen – alle übrigen Links folgen in ihrer bisherigen Reihenfolge. IDs, die nicht zur Page gehören, lehnt die API mit 422 validation_failed ab; details.missing_link_ids nennt sie.

Short Links

Methode und Pfad	Scope	Zweck
GET /v1/short-links	read:short_links	Short Links mit limit, offset, sort und Suche q; die Antwort enthält total
POST /v1/short-links	write:short_links	Anlegen; Pflicht: target_url (http oder https, 8–2048); optional title (bis 120) und custom_slug (3–32, Kleinbuchstaben, Ziffern, Bindestriche)
GET /v1/short-links/{id}	read:short_links	Ein Short Link
PATCH /v1/short-links/{id}	write:short_links	target_url oder title ändern
DELETE /v1/short-links/{id}	write:short_links	Short Link löschen

Ist das Short-Link-Limit des Plans erreicht, antwortet die API mit 402 plan_limit_reached.

Assets

Methode und Pfad	Scope	Zweck
GET /v1/assets	read:assets	Assets des Workspaces
POST /v1/assets	write:assets	Datei hochladen (multipart/form-data, Feld file; optional page_id, kind, title, alt_text)
DELETE /v1/assets/{assetId}	write:assets	Asset löschen

Formulare

Methode und Pfad	Scope	Zweck
GET /v1/forms	read:forms	Formulare
POST /v1/forms	write:forms	Formular anlegen; Pflicht: name und fields (1–100 Felder)
GET /v1/forms/{id}	read:forms	Ein Formular
PATCH /v1/forms/{id}	write:forms	Formular ändern
DELETE /v1/forms/{id}	write:forms	Formular löschen
GET /v1/forms/{id}/summary	read:forms	Zusammenfassung
GET /v1/forms/{id}/submissions	read:forms	Einsendungen, neueste zuerst (limit 1–500, Standard 100; weitere Seiten über cursor = next_cursor)
GET /v1/forms/{id}/submissions/export	read:forms	Alle Einsendungen als CSV-Datei, neueste zuerst, bis zum Export-Limit des Plans (ab Creator Pro); Header X-Export-Truncated zeigt, ob gekürzt wurde

Statistiken

Methode und Pfad	Scope	Zweck
GET /v1/stats/pages/{id}/summary	read:stats	Kennzahlen einer Page
GET /v1/stats/pages/{id}/timeseries	read:stats	Verlauf einer Page
GET /v1/stats/pages/{id}/compare	read:stats	Vergleich mit dem Vorzeitraum
GET /v1/stats/pages/{id}/links	read:stats	Klicks pro Link
GET /v1/stats/pages/{id}/widgets	read:stats	Klicks auf Widgets
GET /v1/stats/pages/{id}/conversions/breakdown	read:stats	Conversions einer Page
GET /v1/stats/workspaces/me/summary	read:stats	Kennzahlen aller Pages
GET /v1/stats/workspaces/me/timeseries	read:stats	Verlauf aller Pages
GET /v1/stats/workspaces/me/compare	read:stats	Vergleich mit dem Vorzeitraum
GET /v1/stats/workspaces/me/top-pages	read:stats	Top-Pages
GET /v1/stats/workspaces/me/conversions/breakdown	read:stats	Conversions des Workspaces
GET /v1/stats/workspaces/me/donations	read:donations	Summen der Unterstützungen

Den Zeitraum wählst du wie unter Paginierung beschrieben mit period oder mit from und to. Wie weit du zurückblicken kannst, hängt vom Plan ab: 365 Tage in Creator Pro und Agency, 730 Tage in Enterprise. Ältere Zeiträume werden auf diese Grenze gekürzt.

Push (nur lesen)

Methode und Pfad	Scope	Zweck
GET /v1/push/history	read:stats	Push-Verlauf (limit, offset)
GET /v1/push/usage	read:stats	Verbrauch des Wochenlimits

Push-Nachrichten senden und Push-Regeln verwalten geht nur im Dashboard.

Workspace, Templates und Domains

Methode und Pfad	Scope	Zweck
GET /v1/workspaces/me/entitlements	read:workspaces	Funktionen und Limits des Plans
GET /v1/workspaces/me/usage	read:workspaces	Aktuelle Nutzung
GET /v1/workspaces/me/usage/metering	read:workspaces	Nutzungsverlauf
GET /v1/workspaces/me/members	read:workspaces	Mitgliederliste
GET /v1/workspaces/me/settings	read:workspaces	Workspace-Einstellungen
GET /v1/workspaces/me/callback-secrets	read:workspaces	Callback-Secrets (ohne Secret im Klartext)
GET /v1/workspaces/me/callback-secrets/{id}	read:workspaces	Ein Callback-Secret (ohne Secret im Klartext)
GET /v1/templates	read:workspaces	Alle Templates
GET /v1/templates/available	read:workspaces	Eingebaute und aktive Workspace-Templates mit gültigen template_key-Werten; Workspace-Templates haben den Key ws:<key> und type workspace
GET /v1/templates/{key}	read:workspaces	Ein Template
GET /v1/workspaces/me/templates	read:workspaces	Eigene Workspace-Templates
GET /v1/workspaces/me/templates/{id}	read:workspaces	Ein Workspace-Template
POST, PATCH, DELETE /v1/workspaces/me/templates[/{id}]	write:templates	Workspace-Templates anlegen, ändern, löschen; html höchstens 60.000 Bytes (sonst 422 validation_failed mit details.reason maxBytes), bis zu 32 asset_slots
GET /v1/domains	read:workspaces	Eigene Domains
GET /v1/domains/available	read:workspaces	Verfügbare Domains für Pages

Nicht über API-Keys

Webhooks, Integrationen, Push senden, Domains verwalten, Mitglieder, Abrechnung und Page löschen gibt es nur im Dashboard. Callback-Secrets legst du ebenfalls nur im Dashboard an und verwaltest sie dort; auflisten und lesen (ohne Secret im Klartext) kannst du sie mit read:workspaces. Eine vollständige Liste steht unter Scopes im Detail. Eingehende Daten – Verkäufe und eigene Live-Daten – schickst du mit eigenen Secrets an die Endpunkte aus Callbacks.

Nichts gefunden?

Schreib uns dein Anliegen – unser Support hilft dir persönlich weiter.

Support kontaktieren

API-Endpunkte nach Bereich

#Anmeldung und öffentliche Endpunkte

#Pages

#Entwurf

#Blöcke

#Links

#Short Links

#Assets

#Formulare

#Statistiken

#Push (nur lesen)

#Workspace, Templates und Domains

#Nicht über API-Keys

Das könnte auch helfen