Points de terminaison

Référence des points de terminaison de conversions, d'envoi et de webhooks de la REST API de Tapeto.

Tous les points de terminaison ci-dessous se trouvent sous le chemin de base https://api.tapeto.dev/api/v1. Chaque route nécessite une authentification — voir Authentification.

Conversions

Créer une conversion

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

builder est l’une des valeurs gutenberg, elementor, oxygen, divi — la disponibilité dépend de votre plan. Le projet doit déjà avoir été analysé (POST /projects/:id/parse) avant de pouvoir être converti.

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

Erreurs possibles : 404 si le projet n’existe pas ou ne vous appartient pas, 422 s’il n’a pas encore été analysé, 403 si le constructeur n’est pas disponible sur votre plan.

Lister les conversions

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 }
  }
}

Récupérer / relancer / supprimer une conversion

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

Envoi vers WordPress

POST /conversions/:id/push

Nécessite une connexion WordPress configurée (connection_id). Pris en charge uniquement pour les constructeurs gutenberg et elementor.

Oxygen et Divi ne sont pas encore envoyables

Appeler push pour une conversion oxygen ou divi retourne 422 BUILDER_NOT_SUPPORTED. Utilisez plutôt l’export — voir Exporter les résultats.

{
  "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
  }
}

Télécharger / exporter

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

export?format=wxr retourne un fichier WordPress eXtended RSS, importable nativement via Outils → Importer sur n’importe quel site WordPress.

Webhooks PRO

Les webhooks sortants sont disponibles sur le plan Studio. Jusqu’à 10 points de terminaison par compte, signés avec HMAC-SHA256.

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

Événements pris en charge : conversion.completed, conversion.failed, project.created, export.ready, ou * pour s’abonner à tous.

Disponibilité des constructeurs par plan

PlanConstructeurs disponibles via l’API
FreeGutenberg
StarterGutenberg, Elementor
ProGutenberg, Elementor, Oxygen
AgencyGutenberg, Elementor, Oxygen, Divi
StudioGutenberg, Elementor, Oxygen, Divi

Demander un constructeur que votre plan n’inclut pas retourne 403 BUILDER_NOT_ALLOWED.