Content API
Zeigen Sie in Surpasso gespeicherte Artikel auf Ihrer Website an.
Beim Besuch des Blogs lädt der Server veröffentlichte Artikel aus Surpasso. Sollen Artikel im vorhandenen Blog-Admin gespeichert werden, verwenden Sie Webhook.
Vorbereitung
- KI-Entwicklungswerkzeug oder Website-Wartungsperson.
- Zugriff auf die Hosting-Einstellungen.
Anleitung an das Website-Werkzeug geben
Kopieren Sie die folgende Anleitung. Bestehendes Design, Artikel und Links sollen erhalten bleiben.
Einrichtungsanleitung anzeigen
Surpasso unterstützt Unternehmen bei Planung, Erstellung und Veröffentlichung von SEO-/GEO-Artikeln. Verbinden Sie diese bestehende Website mit Surpasso. Prüfen Sie zuerst Framework, Blogrouten, Artikelspeicherung, Design und Bereitstellung und verwenden Sie vorhandene Funktionen weiter. Bauen Sie die Website nicht neu auf und löschen oder überschreiben Sie keine bestehenden Artikel.
Content API verwenden: Die Website liest veröffentlichte Surpasso-Artikel serverseitig. Artikel werden in Surpasso verwaltet und nicht automatisch in das lokale CMS kopiert. Servervariablen: SURPASSO_URL=https://surpasso.ai, SURPASSO_CONTENT_API_KEY=<sicher in den Bereitstellungseinstellungen konfigurieren>. Authorization: Bearer mit dem serverseitigen Schlüssel senden. Niemals NEXT_PUBLIC_ verwenden.
Tatsächliche Endpunkte: GET /api/content/v1/articles?limit=50 liefert {items:[article],nextCursor}; nextCursor als cursor-Parameter für weitere Seiten verwenden. GET /api/content/v1/articles/{id-or-slug} liefert {item:article}. updated_since filtert Aktualisierungen. Nur veröffentlichte Artikel sind lesbar. Eine leere Liste ist kein Verbindungsfehler; niemals automatisch einen Entwurf zum Testen veröffentlichen. 401, 404, 429 (Retry-After beachten) und temporäre Fehler behandeln. ETag / If-None-Match und 304 unterstützen; eine 304-Antwort nicht als JSON parsen.
Feldzuordnung: id = dauerhafte Artikelidentität; revision = Inhaltsversion; title = Überschrift; slug = Artikelpfad; excerpt = Zusammenfassung; contentMarkdown / contentHtml = Textkörper (passendes Format des vorhandenen Editors verwenden, HTML sicher verarbeiten); metaTitle / metaDescription = SEO-Metadaten; featuredImage.url / alt = Titelbild und Alternativtext; images = Bilder im Inhalt; author, authorType, authorUrl = Autor; editor, reviewer und jeweilige Type-/Url-Felder = redaktionelle Angaben; categories / tags = Taxonomie; language = Inhaltssprache; contentFamilyId / alternates = Sprachbeziehungen und Links; structuredData = strukturierte Artikeldaten; canonicalUrl = kanonische URL. Verwenden Sie die tatsächlichen öffentlichen Pfade der Website und übernehmen Sie keine falsche kanonische URL. Nullwerte sauber behandeln; nicht unterstützte optionale Felder dürfen die Veröffentlichung nicht blockieren.
Artikel enthalten außerdem publishedAt und updatedAt für Datumsanzeige und Cache-Aktualisierung. Bestehende Blogpfade wiederverwenden; Übersicht, Detail, sichere Textdarstellung, SEO, Canonical, Open Graph, Sprachlinks und Sitemap ergänzen. Bestehende Artikel und URLs erhalten. Erfolgreiche Abrufe zwischenspeichern und bei vorübergehenden Ausfällen nach Möglichkeit Cache anzeigen; Verzögerung der Aktualisierung erklären.
Führen Sie geeignete Prüfungen aus und erklären Sie anschließend in verständlicher Sprache: geänderte Funktionen, Bereitstellungsschritte, Namen der zu konfigurierenden Umgebungsvariablen und das jeweilige Dashboard, die in Surpasso einzutragende URL sowie die Prüfung eines Artikels und einer Aktualisierung. Geheimnisse sollen ausschließlich über die Umgebungsvariablen der Bereitstellungsplattform konfiguriert werden, niemals im Chat, in Git oder im Browsercode.Schlüssel und Umgebungsvariablen setzen
Unter Integrations → Custom → Content API einen Schlüssel erstellen und während der einmaligen Anzeige speichern. Im Hosting SURPASSO_URL=https://surpasso.ai und SURPASSO_CONTENT_API_KEY=<Schlüssel> hinzufügen und neu bereitstellen. Artikel-Links müssen die eigene Domain verwenden.
Artikel und Leseaktivität prüfen
Einen Artikel aus Content Calendar veröffentlichen und Text, Bilder und Links im eigenen Blog prüfen. In der Verbindung Leseaktivität prüfen wählen und die Website zusätzlich selbst öffnen. Eine Änderung in Surpasso speichern und erneut veröffentlichen; nach der Cache-Aktualisierung muss dieselbe Seite geändert sein.
Nur veröffentlichte Artikel erscheinen; Entwürfe bleiben privat. Content API legt nichts im eigenen Blog-Admin ab.
Keine Artikel, Fehler oder verzögerte Änderung
Veröffentlichung, richtigen Schlüssel, Umgebungsvariable und erneute Bereitstellung prüfen. Eine leere Liste bedeutet keine passenden veröffentlichten Artikel, 401 weist auf den Schlüssel hin, ein fehlender Artikel kann eine falsche Website-Verknüpfung haben. Bei Cache-Verzögerung das Aktualisierungsintervall mit dem Website-Werkzeug prüfen.
Schlüssel verloren oder offengelegt
Schlüssel in der Verbindung ersetzen, SURPASSO_CONTENT_API_KEY im Hosting aktualisieren und neu bereitstellen. Der alte Schlüssel funktioniert nicht mehr und ist nicht erneut sichtbar.
Technische Referenz: API und Felder
Serverseitig Authorization: Bearer <server-side-key> senden. GET /api/content/v1/articles?limit=50 liefert die Liste, GET /api/content/v1/articles/{id-or-slug} einen Artikel. limit 1–50, Pagination über nextCursor/cursor, Änderungen über updated_since. ETag/If-None-Match und 304 unterstützen; einen leeren 304-Body nicht als JSON parsen. Pro Verbindung gelten 600 Anfragen pro Minute; Retry-After bei 429 beachten und 401, 404 und temporäre Fehler getrennt behandeln.
Artikel enthalten stabile ID und revision, Titel, Slug, Auszug, Markdown/HTML, SEO-Daten, Bilder, Credits, Kategorien, Tags, Sprache/Alternativen, strukturierte Daten und Zeiten. Optionale Werte können null sein. Erfolgreiche Reads cachen und Zugangsdaten bei Ausfällen nie offenlegen.