Zum Inhalt springen

Bau mit Etchify.

AI-Integration im Pro, direkte REST-API im Business. OpenAPI-Spec, MCP-Endpoint, 11 Read + 12 Write Tools im Pro mit Admin-Confirm-Step · direkte REST-API für eigene Software im Business. Echtzeit-Order-Push via Shopifys nativem orders/create-Webhook.

Endpoints

Alle Endpoints sind über den API-Key auf einen Shop scoped.

OpenAPI-Spezifikation

Importiere diese URL in ChatGPT Custom GPT Actions oder generiere einen typisierten Client.

https://api.etchify.app/api/openapi.json
Öffnen

MCP-Endpoint

Nutze diese URL für Claude.ai Custom-Connectors und Claude Desktop / Claude Code mcpServers-Config.

https://api.etchify.app/mcp

Authentifizierung

Jeder Request braucht einen Header.

X-API-Key: sk_etch_...
  • Jederzeit unter Einstellungen → AI Integration im Etchify-Admin rotieren oder widerrufen.
  • Jeder Key ist auf einen Shop gescoped. Keys verlassen niemals deinen Shopify-Admin bis du sie kopierst — sie werden nur einmal beim Generieren angezeigt.

Rate-Limits

StarterKein API-Zugriff im Starter
Pro60 req/minReicht locker für menschliche AI-Konversationen
Business600 req/minGebaut für Skript-getriggerte Bulk-Operationen
14-Tage-Trial600 req/minBusiness-äquivalent im Trial

Error-Codes

Standard-HTTP. Body ist immer JSON: { error, message, request_id }.

401Fehlender oder fehlerhafter X-API-Key Header
403API-Key valid aber Plan enthält diesen Endpoint nicht (z.B. AI im Starter, REST im Pro)
404Resource in diesem Shop nicht gefunden
409Conflict — Resource existiert bereits (nur POST-Mutations)
429Rate-Limit überschritten — siehe Retry-After Header
500Server-Error — request_id ist geloggt, schreibe an help@etchify.app

MCP-/REST-Tool-Inventar

11 Read-Only-Tools heute verfügbar. Gleiche Tools egal ob über OpenAPI, MCP-HTTP, MCP-stdio oder REST direkt.

ToolZweckPlan
list-productsListet alle konfigurierten Produkte deines ShopsPro+
get-product-configDetail-Config für ein Produkt (Materialien, Modi, Maße)Pro+
browse-templatesFiltert Templates nach Produkt, Kategorie oder ShapePro+
list-materialsLibrary aller im Shop konfigurierten MaterialienPro+
list-shapesLibrary aller Custom-ShapesPro+
list-all-templatesFlache Liste aller Templates über alle ProduktePro+
health-checkService-Health und Uptime-StatusPro+
get-api-specGibt die OpenAPI-Spec inline zurückPro+
get-setup-guideWalkthrough der noch fehlenden Setup-SchrittePro+
diagnose-setupErkennt Fehlkonfigurationen quer über Produkte, Materialien, ShapesPro+
shop-infoShop-Name, Plan, Install-Datum, Locale, WährungPro+

Probier diese Prompts

Frag deinen ChatGPT- oder Claude-Verbund nach Etchify-Daten — kopier eine Zeile, paste sie in dein AI-Frontend, fertig. 23 Tools (11 Read + 12 Write) liegen unter der Haube.

Analytics & Insights

Read-Tools
Welche Materialien verkaufen sich diesen Monat am besten?
Welches Template konvertiert bei Customers am haeufigsten?
Wie hoch ist mein Etchify-Anteil am Umsatz dieses Quartal?
Auf welchem Material designen die meisten Kunden?

Bibliothek inspizieren

Read-Tools
Liste mir alle Materialien in der Kategorie Holz.
Welche Produkte nutzen die Shape 'Coaster Round'?
Was sind die Production-Settings fuer Material 'Eiche 6mm'?
Welche Templates wurden in den letzten 30 Tagen kein einziges Mal genutzt?

Setup & Debugging

Diagnose + Write-Tools (Business)
Mein Customer kann das Design nicht in den Warenkorb legen — was koennte schief gehen?
Fuehre mich durch die Aktivierung von PDF/X-1a-Export fuer meinen Print-Shop.
Wie fuege ich einen neuen Fertigungstyp fuer Sublimations-Druck hinzu?
Erkenne fehlerhafte API-Key-Konfigurationen in meinem Setup.

Voraussetzung: AI-Integration aktiviert (Pro+). Write-Aktionen brauchen einen Confirm-Step im Etchify-Admin.

Integration Cookbook

Drei Rezepte fuer Owner die Etchify in eigene Workflows einbinden — Bulk-Fetch via curl, Echtzeit-Push via Shopifys nativem orders/create-Webhook, n8n-HTTP-Node-Config. Alle Snippets nutzen die REST-API (Business+).

Bulk-Fetch designed Orders (curl)

Pull alle designed Orders einer Zeitspanne in dein ERP. Loesst Tabellen-Imports und CSV-Workflows ohne weitere Tools.

# Fetch designed orders since yesterday
curl -X GET 'https://api.etchify.app/api/v1/orders?since=2026-05-03T00:00:00Z&status=designed' \
  -H 'X-API-Key: shop_etchify_xxxxxxxxxxxxxxxxxxxxxxxx' \
  -H 'Accept: application/json'
# Fetch designed orders since yesterday curl -X GET 'https://api.etchify.app/api/v1/orders?since=2026-05-03T00:00:00Z&status=designed' \ -H 'X-API-Key: shop_etchify_xxxxxxxxxxxxxxxxxxxxxxxx' \ -H 'Accept: application/json'

Echtzeit-Push via Shopifys orders/create

Abonniere Shopifys nativen orders/create-Webhook auf deinen Endpoint. Jede Etchify-Cart-Property (Design-ID, Preview-URL, Material, Size) ist automatisch enthalten. HMAC-Verify via Shopifys Standard-Signatur. Anschluss an dein ERP, Email-Tool oder Slack-Bridge.

// Express + Node — verify HMAC + dispatch to ERP
import express from 'express';
import crypto from 'crypto';

const app = express();
app.use(express.raw({ type: 'application/json' }));

app.post('/etchify-webhook', (req, res) => {
  const sig = req.headers['x-etchify-signature'];
  const expected = crypto
    .createHmac('sha256', process.env.ETCHIFY_WEBHOOK_SECRET)
    .update(req.body)
    .digest('hex');
  if (sig !== expected) return res.sendStatus(401);

  const event = JSON.parse(req.body.toString());
  if (event.type === 'order.designed') {
    // pushToErp(event.data) — your ERP integration here
  }
  res.sendStatus(200);
});
// Express + Node — verify HMAC + dispatch to ERP import express from 'express'; import crypto from 'crypto'; const app = express(); app.use(express.raw({ type: 'application/json' })); app.post('/etchify-webhook', (req, res) => { const sig = req.headers['x-etchify-signature']; const expected = crypto .createHmac('sha256', process.env.ETCHIFY_WEBHOOK_SECRET) .update(req.body) .digest('hex'); if (sig !== expected) return res.sendStatus(401); const event = JSON.parse(req.body.toString()); if (event.type === 'order.designed') { // pushToErp(event.data) — your ERP integration here } res.sendStatus(200); });

n8n HTTP-Request-Node

Drop-in JSON fuer einen n8n-Workflow. Fetcht stuendlich neue designed Orders mit Auth-Header. Kombinierbar mit Schedule-Trigger und Notion/Airtable-Out.

// n8n HTTP Request node config (manual export to JSON)
{
  "method": "GET",
  "url": "https://api.etchify.app/api/v1/orders",
  "authentication": "genericCredentialType",
  "genericAuthType": "httpHeaderAuth",
  "sendQuery": true,
  "queryParameters": {
    "parameters": [
      { "name": "since", "value": "{{$now.minus({hours:1}).toISO()}}" },
      { "name": "status", "value": "designed" }
    ]
  },
  "options": { "response": { "response": { "responseFormat": "json" } } }
}
// n8n HTTP Request node config (manual export to JSON) { "method": "GET", "url": "https://api.etchify.app/api/v1/orders", "authentication": "genericCredentialType", "genericAuthType": "httpHeaderAuth", "sendQuery": true, "queryParameters": { "parameters": [ { "name": "since", "value": "{{$now.minus({hours:1}).toISO()}}" }, { "name": "status", "value": "designed" } ] }, "options": { "response": { "response": { "responseFormat": "json" } } } }

Snippets sind Starter-Templates — passe API-Keys, Secrets und Endpoints an deinen Stack an. Echtzeit-Push nutzt Shopifys orders/create-Webhook (kostenlos in jedem Shopify-Plan), der jede Etchify-Cart-Property (_design_id, _preview_url, material, size) ausliefert — kein Etchify-seitiges Setup noetig.

Live: AI Write Tools + Direkte REST

Echtzeit-Push (Shopify-native)

Abonniere Shopifys orders/create-Webhook auf deinen Endpoint — jede Etchify-Cart-Property (_design_id, _preview_url, material, size) wird automatisch ausgeliefert. HMAC-Verify via Shopifys Standard-Signatur. Kostenlos in jedem Shopify-Plan.

GraphQL-Endpoint

Schema-getriebene Queries für fortgeschrittene Integrationen — Pagination, Fragments, Mutations mit Confirm-Step.

AI Write Tools (Pro+)

12 Mutations für AI-Agenten auf Pro und Business: enable-product, create-shape, set-brand-colors, upload-shop-logo, create-template, etc. Jeder Write braucht explizite Bestätigung im Etchify-Admin.

API-Changelog

Breaking-Changes und neue Endpoints werden im Changelog getrackt.

Changelog ansehen

Brauchst du Hilfe?

Schreibe an help@etchify.app — Pro- und Business-Pläne bekommen Priority-Routing.