byteriver API — Dokumentation & Entwicklerportal

Die öffentliche byteriver API ermöglicht das Lesen von Produktinformationen aus unserem Shopify-Shop. Sie eignet sich für die Suche nach digitalen Shopify-Blöcken, E-Books und öffentlich angebotenen Leistungen. Die Schnittstelle stellt keine privaten Kunden-, Bestell- oder Administrationsdaten bereit.

Schnellstart ohne API-Schlüssel

Die öffentliche Produktsuche ist kostenlos und benötigt weder Registrierung noch API-Schlüssel. Sie fragt den echten öffentlichen Katalog ab; eine separate Sandbox wird derzeit nicht angeboten. Dieser Einstieg verändert weder Warenkörbe noch Bestellungen.

curl -sS -G 'https://byteriver.de/search/suggest.json' \
  --data-urlencode 'q=Shopify' \
  --data-urlencode 'resources[type]=product' \
  --data-urlencode 'resources[limit]=3'

Endpunkt und Schema

GET /search/suggest.json: q ist die Suchanfrage; resources[type]=product begrenzt die Suche auf Produkte; resources[limit] erlaubt 1 bis 10 Ergebnisse. Die Antwort enthält resources.results.products mit Produkt-ID, Titel, Handle und URL. Keine Treffer ergeben eine leere Produktliste.

Das OpenAPI-3.1-Dokument beschreibt die tatsächlich verfügbare öffentliche Produktsuche mit einem eindeutigen operationId, typisierten Parametern und Antwortschemata. Die Serveradresse im Dokument bleibt byteriver.de, auch wenn die Schemadatei über das Shopify-CDN ausgeliefert wird.

Authentifizierung und Berechtigungen

Die dokumentierte Produktsuche ist öffentlich und benötigt keine OAuth-Scopes. Das ist keine Berechtigung zum Zugriff auf Kundendaten, Bestellungen oder Shopify Admin. byteriver stellt derzeit keinen eigenen OAuth-Server und keine selbst erzeugbaren privaten API-Schlüssel bereit. Für geschützte Commerce-Funktionen gelten ausschließlich die vom Shopify-UCP-Dienst tatsächlich veröffentlichten Anforderungen.

Fehler und Wiederholungen

Ungültige Suchparameter liefern HTTP 422 mit den JSON-Feldern status, message und description. Korrigieren Sie den Parameter anhand des Schemas. Bei HTTP 429 warten Sie mindestens die in Retry-After genannte Zeit. Prüfen Sie vor dem Parsen immer Status und Content-Type: unbekannte URLs und vorgeschaltete Dienste können leere oder HTML-Fehler liefern. Einheitliche JSON-Fehler mit zusätzlichen Lösungshinweisen sind derzeit nicht für alle Routen verfügbar.

Agenten und MCP

Für agentengestützte Einkaufsaktionen verwenden Sie die byteriver MCP-Integration, die UCP-Discovery und die Shopify-Einkaufsanweisungen. Endpunkte und Versionen immer aus dem aktuellen Profil lesen. Änderungen am Warenkorb und Käufe benötigen die dort vorgeschriebenen Werkzeuge und Käuferfreigaben.

Weitere Ressourcen

Agentenleitfaden mit Einsatzfällen · Sitemap · Kontakt · Über byteriver

Technische Grundlage: Shopify Predictive Search API. Eine eigene veröffentlichte CLI und eine isolierte Sandbox stehen derzeit nicht zur Verfügung.