Partner Suite

Bauen Sie auf unserer Plattform auf

Eine REST-API mit Swagger-Dokumentation, kundenbezogenen API-Schlüsseln und OAuth 2.1-Autorisierung. Rufen Sie Daten ab, senden Sie Updates und integrieren Sie Synup nahtlos in Ihren bestehenden Tech-Stack.

REST · JSON OpenAPI 3.0 OAuth 2.1 + PKCE 9 Kategorien

Kostenlos testen Dokumentation lesen

Swagger UI direkt in Ihrem Dashboard 14 Tage kostenlos testen · Keine Kreditkarte

at-risk-clients.js JavaScript

// Clients whose health score dropped below 60
const res = await fetch(
  'https://api.synup.com/v1/clients?health_lt=60&limit=2', {
    headers: {
      'Authorization': 'Bearer sk_live_a1b2c3d4e5f6...',
      'Content-Type': 'application/json'
    }
  }
);

const { data } = await res.json();

200 OK application/json 142 ms

{
  "data": [
    { "id": "cl_8f2ka91", "name": "Harbor Coffee",
      "health": 45, "rating": 3.6, "status": "at_risk" },
    { "id": "cl_3md7x02", "name": "Lakeside Pet Clinic",
      "health": 34, "rating": 3.1, "status": "at_risk" }
  ],
  "has_more": false
}

Agenturen bauen auf der Synup API auf

REST API

Jede Ressource, eine einheitliche API

Die Synup API folgt REST-Konventionen — ressourcenorientierte URLs, Standard-HTTP-Methoden, JSON-Antworten. Die Swagger-UI bietet Ihnen eine durchsuchbare Referenz mit Ausprobierfunktion. Die Abdeckung umfasst Einträge, Bewertungen, Social, GBP, Analysen, Kampagnen und Reseller-Funktionen.

RESTful, ressourcenorientiert, JSON für Input und Output

Swagger-UI mit Try-it-out-Funktion für jeden Endpunkt

Abdeckung: Einträge, Bewertungen, Social, GBP, Analysen, Kampagnen, Reseller

Einheitliche Fehlerantworten mit Standard-HTTP-Statuscodes

SAPI-Referenzv1 Endpunkte filtern

Methode	Endpunkt	Beschreibung
GET	/v1/clients	Alle Kunden auflisten
GET	/v1/clients/:id	Kundendetails abrufen
POST	/v1/clients	Kunden erstellen
GET	/v1/clients/:id/reviews	Bewertungen für einen Kunden auflisten
POST	/v1/clients/:id/posts	Social-Media-Beitrag erstellen
GET	/v1/clients/:id/listings	Eintragsstatus abrufen
GET	/v1/clients/:id/seo/rankings	SEO-Rankings abrufen
GET	/v1/clients/:id/aeo/visibility	KI-Sichtbarkeitsscore abrufen

Vollständige API-Referenz anzeigen 8 von 140+ Endpunkten

api.synup.com/docs

SSynup APIv1.0.4 OAS 3.0

Kunden GETPOSTPUTDEL

BewertungenGETPOST9 Ops

EinträgeGETPUT14 Ops

Social MediaGETPOSTDEL11 Ops

Authentifizierung

API-Schlüssel oder OAuth 2.1 — Sie haben die Wahl

Generieren Sie für einfache Integrationen einen API-Schlüssel und übergeben Sie ihn als Bearer-Token. Nutzen Sie für Produktionsanwendungen OAuth 2.1 mit PKCE für sicheren Zugriff mit festgelegten Berechtigungen. Mit der dynamischen Client-Registrierung (RFC 7591) kann sich Ihre App programmgesteuert registrieren.

Bearer-Token-Authentifizierung für schnelle Integrationen

OAuth 2.1 mit PKCE für Produktionsanwendungen

Dynamische Client-Registrierung (RFC 7591)

1-Stunden-Access-Tokens, 30-Tage-Refresh-Tokens

Scopes: mcp:read, mcp:write

Bearer-TokenDer schnellste Weg — ein Header

Authorization: Bearer sk_live_a1b2c3d4e5f6...

GültigkeitsbereichAlle Kunden

Schlüsselformat64-Zeichen-Hex

Jederzeit in den Einstellungen erneuern oder widerrufen

OAuth 2.1 + PKCEFür Produktionsanwendungen

1RegistrierenPOST /oauth/mcp/registerclient_id

2AutorisierenGET /oauth/mcp/authorizeZustimmung

3TokenPOST /oauth/mcp/tokenAccess + Refresh

Scopesmcp:readmcp:write

Access-Token 1 Stunde · Refresh-Token 30 Tage

Schlüsselverwaltung

Kundenbezogene API-Schlüssel

Erstellen Sie API-Schlüssel ohne Einschränkung, für alle oder für bestimmte Kunden. Der Agent nutzt automatisch den passenden Schlüssel, wenn Sie im Chat einen Kunden nennen. Rotieren Sie Schlüssel ohne Ausfallzeiten und behalten Sie im Blick, welcher Schlüssel welchem Kunden zugewiesen ist.

Einstellungen öffnen · API-Schlüssel

SAPI-Schlüssel3 aktiv API-Schlüssel hinzufügen

Schlüssel	Name	Vorschau	Scope	Erstellt	Aktionen
K01	Produktion — Alle KundenVom Agent-Container verwendet	sk_live_a1b2...f6	Alle Kunden	2026-03-11	ErneuernBearbeitenLöschen
K02	Nur Bella VistaAuf ein Kundenkonto beschränkt	sk_live_x7y8...z9	1 Kunde	2026-05-02	ErneuernBearbeitenLöschen
K03	Staging (ungenutzt)Noch keine Kunden zugewiesen	sk_test_m3n4...p5	Nicht zugewiesen	2026-06-19	ErneuernBearbeitenLöschen

Scope-Änderungen greifen bei der nächsten Anfrage — kein Re-Deployment erforderlich

Alle Schlüssel, IDs, Endpunkte und Payloads auf dieser Seite sind illustrative Beispiele — ersetzen Sie diese vor der Veröffentlichung durch Ihre eigenen.

Alles, was Sie für die Integration brauchen

EinträgeReputationSocial GBPAnalyticsKampagnen Store Locator & PagesKundenverwaltungReseller

Swagger UI-Dokumentation

Durchsuchen Sie jeden Endpunkt, testen Sie Anfragen live und sehen Sie Antwort-Schemas ein. Keine separate Dokuseite erforderlich.

KundenGETPOST

BewertungenGETPUT

Kundenbezogene Schlüssel-Scopes

Weisen Sie jeden Schlüssel keinem, allen oder bestimmten Kunden zu. Der Agent nutzt automatisch den richtigen Schlüssel.

sk_live_x7y8...z93 Kunden

OAuth 2.1 + PKCE

Enterprise-Autorisierung mit dynamischer Client-Registrierung und Refresh-Tokens.

1POST /oauth/mcp/register

2GET /oauth/mcp/authorize

3POST /oauth/mcp/token → 200

Schlüsselrotation

Generieren Sie einen neuen Schlüssel und tauschen Sie ihn ohne Ausfallzeiten aus. Alte Schlüssel werden sofort widerrufen.

sk_live_a1b2...f6Erneuern

API-Kategorien

Endpunkte strukturiert nach Bereich: Einträge, Bewertungen, Social, GBP, Analytics, Kampagnen, Reseller.

EinträgeBewertungenSocialGBPAnalyticsKampagnenReseller

Anthropic-Schlüssel-Sync

Fügen Sie Ihren Anthropic-API-Schlüssel einmalig ein. Er synchronisiert sich mit dem Agent-Container und wird automatisch neu bereitgestellt.

sk-ant-...Schlüssel speichern

// Adrian Graphics & Marketing rollout
const results = await synup.get('/v1/campaigns/results');
// nearly every client: increased sales revenue
// many clients: 400%+ within first few months

AG Adrian Graphics & MarketingAgentur

Adrian rollte Synup zügig für zahlreiche Agenturkunden aus — und vereinte Präsenz, Reputation und Kampagnen auf einen Schlag. Die Erfolge stellten sich fast über Nacht ein: Nahezu jeder Kunde verzeichnete bereits in den ersten Monaten steigende Umsätze.

Adrian Graphics & MarketingAgentur für Safeway, SportClips und weitere

Ganze Story lesen →

FAQ

Was Entwickler vor der ersten Anfrage wissen möchten

Was kann ich mit der API tun?

Rufen Sie Kundendaten ab (Einträge, Bewertungen, Rankings, KI-Sichtbarkeit), erstellen und verwalten Sie Social-Media-Beiträge, stoßen Sie Scans an, verwalten Sie Kunden und automatisieren Sie Workflows. Die Abdeckung umfasst den gesamten Funktionsumfang von Synup.

Wie authentifiziere ich mich?

Für schnelle Integrationen nutzen Sie ein Bearer-Token (API-Schlüssel). Für Produktions-Apps verwenden Sie OAuth 2.1 mit PKCE. Beide Methoden sind in der Swagger UI dokumentiert.

Kann ich API-Schlüssel auf bestimmte Kunden einschränken?

Ja. Jeder Schlüssel kann keinen Kunden, allen Kunden oder einer bestimmten Teilmenge zugewiesen werden. Der Agent verwendet kontextbasiert automatisch den richtigen Schlüssel.

Gibt es ein Rate Limit?

Ja. Rate Limits sind in der Swagger UI pro Endpunkt dokumentiert. Die Standardlimits sind für typische Integrationsanwendungsfälle großzügig bemessen.

Was ist der Unterschied zwischen der API und MCP?

Die API ist REST — traditionelle HTTP-Endpunkte zum Abrufen von Daten und Senden von Updates. MCP ist ein Protokoll für KI-Agenten, um Synup-Tools nativ aufzurufen. Nutzen Sie die API für benutzerdefinierte Integrationen und MCP für KI-Agenten-Workflows.

Gibt es ein SDK?

Die API nutzt Standard-REST-Konventionen, sodass jeder HTTP-Client funktioniert. Wir empfehlen die Verwendung des per Swagger generierten Clients für die Sprache Ihrer Wahl.

Jetzt entwickeln

Erstellen Sie einen Schlüssel, rufen Sie einen Endpunkt auf und lesen Sie die Antwort aus. Die Swagger UI ist direkt in Ihrem Dashboard verfügbar, sobald Ihre Testphase beginnt.

curl https://api.synup.com/v1/clients -H "Authorization: Bearer $SYNUP_KEY"

Kostenlos testen Dokumentation lesen

Keine Kreditkarte erforderlich Live-Synchronisierung in wenigen Minuten Jederzeit kündbar