Endpunkte

Referenz für die Conversions-, Push- und Webhooks-Endpunkte der Tapeto-REST-API.

Alle unten aufgeführten Endpunkte liegen unter dem Basispfad https://api.tapeto.dev/api/v1. Jede Route erfordert eine Authentifizierung — siehe Authentifizierung.

Conversions

Eine Conversion erstellen

POST /conversions
{
  "project_id": "uuid",
  "builder": "gutenberg",
  "metadata": { "custom": "data" }
}

builder ist einer von gutenberg, elementor, oxygen, divi — die Verfügbarkeit hängt von deinem Plan ab. Das Projekt muss bereits geparst sein (POST /projects/:id/parse), bevor du es konvertieren kannst.

{
  "ok": true,
  "data": { "conversion": { "id": "uuid", "status": "queued", "...": "..." } },
  "message": "Conversion queued successfully. Check status with GET /conversions/:id"
}

Mögliche Fehler: 404, wenn das Projekt nicht existiert oder dir nicht gehört, 422, wenn es noch nicht geparst wurde, 403, wenn der Builder in deinem Plan nicht verfügbar ist.

Conversions auflisten

GET /conversions?page=1&project_id=uuid&builder=gutenberg&status=completed
{
  "ok": true,
  "data": {
    "conversions": [
      {
        "id": "uuid",
        "project_id": "uuid",
        "builder": "elementor",
        "status": "completed",
        "progress": 100,
        "fidelity_score": 87,
        "output_data": { "...": "..." },
        "created_at": "...",
        "updated_at": "..."
      }
    ],
    "meta": { "page": 1, "pageSize": 20, "total": 150, "totalPages": 8 }
  }
}

Conversion abrufen / wiederholen / löschen

GET    /conversions/:id
PATCH  /conversions/:id
DELETE /conversions/:id
POST   /conversions/:id/retry

Push zu WordPress

POST /conversions/:id/push

Erfordert eine konfigurierte WordPress-Verbindung (connection_id). Nur für die Builder gutenberg und elementor unterstützt.

Oxygen und Divi sind noch nicht pushbar

Ein push-Aufruf für eine oxygen- oder divi-Conversion gibt 422 BUILDER_NOT_SUPPORTED zurück. Nutze stattdessen den Export — siehe Ergebnisse exportieren.

{
  "ok": true,
  "data": {
    "page_id": 123,
    "page_title": "Home",
    "page_url": "https://example.com/home",
    "edit_url": "https://example.com/wp-admin/post.php?post=123&action=edit",
    "preview_url": "https://example.com/home",
    "elementor_injected": true
  }
}

Herunterladen / exportieren

GET /conversions/:id/download
GET /conversions/:id/file?part=page|header|footer|sidebar
GET /conversions/:id/export?format=wxr

export?format=wxr liefert eine WordPress-eXtended-RSS-Datei, die nativ über Werkzeuge → Importieren auf jeder WordPress-Website importiert werden kann.

Webhooks PRO

Ausgehende Webhooks sind im Studio-Plan verfügbar. Bis zu 10 Endpunkte pro Account, signiert mit HMAC-SHA256.

GET    /webhooks
POST   /webhooks
GET    /webhooks/:id
PATCH  /webhooks/:id
DELETE /webhooks/:id
GET    /webhooks/:id/deliveries
POST   /webhooks/:id/test

Unterstützte Events: conversion.completed, conversion.failed, project.created, export.ready, oder *, um alle zu abonnieren.

Builder-Verfügbarkeit nach Plan

PlanÜber die API verfügbare Builder
FreeGutenberg
StarterGutenberg, Elementor
ProGutenberg, Elementor, Oxygen
AgencyGutenberg, Elementor, Oxygen, Divi
StudioGutenberg, Elementor, Oxygen, Divi

Wird ein Builder angefordert, der im aktuellen Plan nicht enthalten ist, antwortet die API mit 403 BUILDER_NOT_ALLOWED.