API-Referenz

Vollständige Referenz für die öffentliche FabHub-API. Das gebrandete Portal ist kanonisch; Sie können den maschinenlesbaren Vertrag auch in einen beliebigen OpenAPI-Viewer laden (Swagger Editor, Redoc, Postman oder Ihre IDE).

• OpenAPI JSON - OpenAPI YAML

Basis-URL

https://api.fabhub.app/v1

Konventionen

• Authentifizieren Sie sich mit X-API-Key (oder Authorization: Bearer). Siehe Authentifizierung.
• Anfrage-Bodies sind JSON mit camelCase-Schlüsseln; Listenfilter sind snake_case-Query-Parameter.
• Listenendpunkte sind seitenbasiert und geben ein pagination-Objekt zurück; siehe Paginierung.
• Schreibendpunkte erfordern einen Idempotency-Key-Header; siehe Idempotenz.
• Fehler verwenden eine stabile Hülle mit einem maschinenlesbaren code; siehe Fehler.

Alle Endpunkte

Diese Tabelle wird aus dem OpenAPI-Vertrag generiert und listet immer jede öffentliche Operation und ihren erforderlichen Scope auf. Die folgenden Abschnitte sind ausgearbeitete Beispiele für die häufigsten Ressourcen; der OpenAPI-Vertrag ist die vollständige Quelle für Anfrage- und Antwortschemata.

Service

GET /v1

Gibt die Fähigkeiten (Methode, Pfad, Scope) zurück, die die aufrufende Anmeldeinformation nutzen kann. Kein Scope erforderlich.

GET /v1/auth/context

Gibt Tenant, Plan, Scopes, Ratenlimit-Stufe und Ablaufdatum der aufrufenden Anmeldeinformation zurück. Kein Scope erforderlich. Siehe das Beispiel im Schnellstart.

Items

GET /v1/items

Scope: items:read. Listet Artikel auf (Produkte, Materialien, Kombinationen).

curl "https://api.fabhub.app/v1/items?page=1&page_size=2&search=widget" \
  -H "X-API-Key: $FABHUB_API_KEY"

{
  "data": [
    {
      "id": "a1c9...",
      "name": "Blue Widget",
      "sku": "WIDG-BLUE",
      "itemType": "product",
      "salePrice": 19.99,
      "purchasePrice": 8.5,
      "isActive": true,
      "category": { "id": "cat_1", "name": "Widgets" },
      "supplier": { "id": "sup_1", "name": "Acme", "company": "Acme Ltd" },
      "updatedAt": "2026-06-19T14:02:00Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 2, "total": 57, "totalPages": 29 }
}

POST /v1/items

Scope: items:write. Erfordert Idempotency-Key. Erstellt einen Artikel.

curl -X POST https://api.fabhub.app/v1/items \
  -H "X-API-Key: $FABHUB_API_KEY" \
  -H "Idempotency-Key: 0b9c4a2e-..." \
  -H "Content-Type: application/json" \
  -d '{"name":"Blue Widget","itemType":"product","salePrice":19.99}'

Gibt { "data": { ...item } } mit dem erstellten Artikel zurück.

GET /v1/items/{item_id}

Scope: items:read. Gibt { "data": { ...item } } zurück, oder 404 mit code: "NOT_FOUND".

PATCH /v1/items/{item_id}

Scope: items:write. Erfordert Idempotency-Key. Akzeptiert eine beliebige Teilmenge der Erstellungsfelder und gibt den aktualisierten Artikel zurück.

Artikel-Unterressourcen

• GET /v1/items/{item_id}/ingredients (Scope items:read) - Komponenten für einen combo-/gefertigten Artikel.
• GET /v1/items/{item_id}/suppliers (Scope items:read) - mit einem Artikel verknüpfte Lieferanten.

Orders

GET /v1/orders

Scope: orders:read.

{
  "data": [
    {
      "id": "ord_1",
      "module": "sell",
      "orderNumber": "SO-1042",
      "status": "open",
      "contactId": "con_7",
      "orderDate": "2026-06-18",
      "dueDate": "2026-06-25",
      "siteId": null,
      "priority": "normal",
      "assignedTo": null,
      "contact": { "id": "con_7", "name": "Globex" },
      "site": null,
      "createdAt": "2026-06-18T10:00:00Z",
      "updatedAt": "2026-06-18T10:05:00Z"
    }
  ],
  "pagination": { "page": 1, "pageSize": 20, "total": 3, "totalPages": 1 }
}

Aufträge unterstützen außerdem POST /v1/orders, GET /v1/orders/{order_id} und PATCH /v1/orders/{order_id} (Schreibvorgänge erfordern Idempotency-Key) sowie GET /v1/orders/{order_id}/lines (Scope orders:read) für Auftragspositionen. Siehe den OpenAPI-Vertrag für die genauen Anfrage-Bodies.

Contacts

GET /v1/contacts

Scope: contacts:read.

Jeder Kontakt: id, name, email, phone, company, contactType, country, contactGroup, isPrimaryContact, isActive, updatedAt.

Kontakte unterstützen außerdem POST /v1/contacts, GET /v1/contacts/{contact_id} und PATCH /v1/contacts/{contact_id} (Schreibvorgänge erfordern Idempotency-Key); siehe den OpenAPI-Vertrag für die Felder.

Organization

GET /v1/organization

Scope: organization:read. Gibt { "data": { "id", "name", "slug", "plan", "createdAt" } } zurück, wobei plan free | standard | pro | enterprise ist.

Usage

GET /v1/usage

Scope: usage:read. Gibt den aktuellen Abrechnungszeitraum, die Anfragesummen (insgesamt und nach Fähigkeit) und die Ratenlimit-Stufe mit dem verbleibenden Budget zurück. Siehe Ratenlimits.

Audit-Ereignisse

GET /v1/audit/events

Scope: audit:read (Enterprise). Cursorpaginierter Export.

{
  "data": [
    {
      "id": "evt_1",
      "actorType": "api",
      "actorId": "key_8f...",
      "action": "item.created",
      "resourceType": "item",
      "resourceId": "a1c9...",
      "metadata": {},
      "ipAddress": "203.0.113.10",
      "createdAt": "2026-06-19T14:02:00Z"
    }
  ],
  "pagination": { "hasMore": true, "nextCursor": { "createdAt": "2026-06-19T14:02:00Z", "id": "evt_1" } }
}

Stock

GET /v1/stock-levels

Gibt die aktuellen Lagerbestände für die Artikel des Tenants zurück (siehe die Tabelle oben für den erforderlichen Scope und den OpenAPI-Vertrag für Filter und die Antwortform).

Webhooks

Vollständige Details zum Lebenszyklus und zur Signierung finden Sie unter Webhooks.