Klare Vertragsverantwortung
Jede Integrationsfläche verlinkt Implementierungsleitfaden und maschinenlesbaren Vertrag getrennt, damit Reviews und Umsetzung nicht vermischt werden.
Entwicklerplattform
API-Verträge und Integrationsleitfäden für Custom-Merchandise
Plane, teste und starte MerchandAise-Integrationen mit klaren OpenAPI-Verträgen, authentifizierten Zugriffspfaden und fokussierten Leitfäden für Community-, Supplier- und Enterprise-Workflows.
Was diese Seite abdeckt
Diese Seite ist der technische Einstieg für Teams, die MerchandAise als API-, SDK- oder Integrationsfläche bewerten. Sie trennt Implementierungsleitfäden von maschinenlesbaren Verträgen, damit Entwickler und AI-Assistenten die richtige Quelle zitieren.
Nutze sie für Assistant-Tooling-Dokumentation, Storefront-Einbettungen, Supplier-Operationen, Enterprise Identity und versionierte OpenAPI-Verträge vor der Implementierung.
API- und Integrationsflächen
| Oberfläche | Implementierungsleitfaden | Maschinenlesbarer Vertrag | Zugriff |
|---|---|---|---|
| Assistant-Tooling-API-DokumentationLies die OpenAPI-Dokumentation für Design Sessions, Tool-Nutzung und Integrationsreviews. Community-, Supplier- und Enterprise-Verträge sind separat ausgewiesen. | ImplementierungsleitfadenAssistant-Tooling-Dokumentation öffnen | Maschinenlesbarer VertragAssistant-Tooling-OpenAPI-JSON/api/docs/openapi.json | Zugriffpublic Öffentliche maschinenlesbare OpenAPI für Assistant- und Tooling-APIs; für Community-, Supplier- und Enterprise-Implementierungen gelten die jeweiligen Domain-Verträge. |
| Community-Einbettungs-APIImplementiere locale-sichere Storefront-Einbettungen, Community-Workflows und authentifizierte Übergaben mit einem versionierten öffentlichen Vertrag. | ImplementierungsleitfadenCommunity-Implementierung prüfen | Maschinenlesbarer VertragOffener Gemeinschaftsvertrag/api/v1/community/public/openapi/v1 | Zugriffpublic |
| Lieferanten-APIVerbinde Onboarding, Katalogdaten und lieferantenseitige Operationen über versionierte Endpunkte für Fulfillment-Workflows. | ImplementierungsleitfadenLieferanten-Integration prüfen | Maschinenlesbarer VertragOffener Lieferantenvertrag/api/v1/supplier/openapi/v1 | Zugriffpublic |
| Enterprise-Identity-APIIntegriere SSO, SCIM-Provisioning und revisionssichere Identity-Flows für Enterprise-Rollouts über geschützte Verträge. | ImplementierungsleitfadenEnterprise-Integration prüfen | Maschinenlesbarer VertragÖffnen Sie den Enterprise-Identity-Vertrag/api/v1/enterprise/identity/openapi/v1 | Zugriffprotected |
Checkliste für die Produktionseinbindung
- 01
Die passende Vertragsfläche wählen
Ordne die Integration zuerst der User Journey zu: Community-Einbettungen für öffentliche Storefronts, Supplier-APIs für Fulfillment-Workflows und Enterprise Identity für SSO, SCIM und geregelte Rollouts.
- 02
Gegen versionierte Verträge testen
Nutze die veröffentlichte OpenAPI-JSON für Client-Generierung, Contract Review, Staging-Validierung und Regressionstests, bevor Produktionsverkehr aktiviert wird.
- 03
Zugriff, Callbacks und Rollback dokumentieren
Dokumentiere Authentifizierungs-Scopes, Callback-URLs, Umgebungsgrenzen, Observability und Rollback-Verantwortung vor dem Launch.
Produktionsschutz
Locale-sichere Discovery
Die Seite ist lokalisiert, in Locale-Sitemaps enthalten und aus der globalen Navigation erreichbar.
Zugriffsgrenzen
Öffentliche Verträge sind direkt verlinkt. Geschützte Enterprise- und assistant-autorisierte Verträge werden nicht als anonymer Zugriff dargestellt.
Bevor diese API-Integration live geht
Nutze diese Prüfung, um öffentliche Verträge in einen unterstützten Integrationsplan mit klarer Zugriffskontrolle, Rollout-Planung und Rollback-Verantwortung zu überführen.
Sandbox und Credentials prüfen lassen
Leite deinen Use Case durch den Integrationsreview, damit öffentliche, Supplier- und geschützte Enterprise-Flächen korrekt eingegrenzt werden.
Auth- und Callback-Grenzen dokumentieren
Halte Scopes, Callback-URLs, Umgebungsnamen, Webhook-Verantwortung und kunden sichtbare Fehlerzustände fest.
Contract Health vor Release prüfen
Prüfe OpenAPI-JSON, geschütztes Zugriffsverhalten, Staging-Requests und Monitoring-Warnungen vor dem ersten Produktionshandoff.
FAQ
Mit welcher MerchandAise API soll ich starten?
Starte mit der Fläche, die zur User Journey passt: Community-Einbettungen für Storefront-Erlebnisse, Supplier-APIs für Fulfillment-Workflows und Enterprise Identity für SSO- oder SCIM-Rollouts.
Sind die API-Verträge öffentlich?
Assistant-Tooling-, Community- und Supplier-OpenAPI-Verträge sind öffentlich. Enterprise Identity und MCP-Tools-Listen sind geschützt und erfordern freigegebenen Zugriff.
Brauchst du einen Integrationsreview?
Teile Workflow, Zielumgebung, Authentifizierungsbedarf und Launch-Timing. Das Integrationsteam empfiehlt die passende Vertragsfläche und den richtigen Rollout-Pfad.