xoPort REST API v2.122.6 – JSON-Schnittstelle

REST · OAuth2 · JSON · v2.122.6

xoPort REST API

Die moderne JSON-Schnittstelle für automatisierte Shop-Integrationen. Exportieren, Importieren und Löschen Sie Daten sicher via OAuth2 (RFC 6749).

OAuth2 Client anlegen Changelog
GET  /Export/JSON/{entity}
POST /Import/JSON/{entity}
PUT  /Import/JSON/{entity}
DELETE /Delete/JSON/{entity}
Hinweis: Die xoPort REST API ist Bestandteil des kostenpflichtigen Zusatzmoduls XONIC Premium: xoPort Datenschnittstelle.
v2.122.6Aktuelle Version
OAuth2RFC 6749 konform
RESTPOST/PUT/DELETE
JSONRequest & Response

API-Bereiche

Die xoPort REST API gliedert sich in vier Hauptbereiche:

Export API

Lesen Sie Daten aus dem Shop aus: Produkte, Kategorien, Kunden, Bestellungen, News und mehr.

  • GET /Export/JSON/{entity}
  • Scope: entity:read
Export API →

Import API

Erstellen und aktualisieren Sie Daten im Shop. Seit v2.1.0 mit RESTful POST/PUT Trennung.

  • POST /Import/JSON/{entity} = INSERT
  • PUT /Import/JSON/{entity} = UPDATE
  • Scope: entity:write
Import API →

Delete API

Löschen Sie Datensätze permanent aus dem Shop. Sicherheitsabfrage via Scope-Berechtigung.

  • DELETE /Delete/JSON/{entity}/{id}
  • Scope: entity:delete
Delete API →

OAuth2 Authentifizierung

Client Credentials Flow (RFC 6749) mit feingranularen Scopes pro Entity und Operation.

  • POST /oauth/token
  • Grant Type: client_credentials
OAuth2 Clients →

Schnellstart

In 3 Schritten zur ersten API-Anfrage:

1

OAuth2 Client anlegen

Erstellen Sie im Backend unter Einstellungen → xoPort → OAuth2 Clients einen neuen API-Zugang mit den benötigten Scopes.

2

Access Token holen

POST /oauth/token mit client_id und client_secret. Token ist 1 Stunde gültig.

3

API-Requests senden

Authorization: Bearer {token} Header bei allen Requests mitschicken.

Beispiel: Kategorien exportieren

# 1. Token holen
TOKEN=$(curl -s -X POST "https://shop.de/xpanel/xoport/oauth/token" \
  -d "grant_type=client_credentials" \
  -d "client_id=xoc_xxx" \
  -d "client_secret=xos_xxx" | jq -r '.access_token')

# 2. Kategorien exportieren
curl -s "https://shop.de/xpanel/xoport/Export/JSON/categories" \
  -H "Authorization: Bearer $TOKEN" | jq .

Jetzt starten

Erstellen Sie Ihren ersten OAuth2 Client und integrieren Sie Ihre Systeme.

OAuth2 Client erstellen

Endpoints

Alle verfügbaren REST-Endpoints der xoPort API - Produkte, Kategorien, Kunden, Hersteller, Lieferanten und mehr.

Export API

Export von Shop-Daten via GET. RESTful URL-Paths seit v2.1.0 - /categories/{id} gibt Single Resource zurück.

Import API

Import von Shop-Daten via POST (INSERT) und PUT (UPDATE). RESTful Trennung seit v2.1.0 für klare Semantik.

Delete API

Import und Aktualisierung von Shop-Daten via POST-Requests. Upsert-Logik, Bulk-Operations bis 50 Datensätze und detaillierte Fehler-Reports.

OAuth2 Clients

Erstellen und verwalten Sie OAuth2 Clients für die sichere API-Authentifizierung nach dem Client Credentials Grant (RFC 6749).

Fehlerbehandlung

Import von Kundenstammdaten für CRM-Integration. Matching über E-Mail-Adresse oder customers_id.

Changelog

Versionshistorie der xoPort REST API - alle Änderungen, neue Features und Bugfixes auf einen Blick.

xoPort JSON API – Die moderne Shop-Schnittstelle

Die xoPort JSON API ermöglicht Entwicklern und Systemintegratoren den programmatischen Zugriff auf alle relevanten Shop-Daten des XONIC Shopsystems. Mit der aktuellen Version 2.122.6 bietet die API nicht nur Export, Import und sichere DELETE-Operationen, sondern auch OAuth2 Client Credentials Grant nach RFC 6749 für maximale Sicherheit bei Server-zu-Server-Kommunikation.

Warum xoPort JSON API?

xoPort basiert auf offenen Standards: RESTful HTTP-Methoden, JSON-Payloads und OAuth2-Authentifizierung mit granularen Scopes. Dies gewährleistet maximale Kompatibilität mit gängigen Programmiersprachen und Frameworks – und erfüllt moderne Sicherheitsanforderungen.

Typische Anwendungsfälle

  • ERP-Integration – Automatischer Produktabgleich mit Warenwirtschaft
  • Marktplatz-Anbindung – Synchronisation mit Amazon, eBay, Idealo
  • PIM-Systeme – Zentrale Produktdatenpflege
  • Business Intelligence – Datenexport für Analysen und Reporting
  • Automatisierung – CI/CD-Pipelines für Content-Updates
  • Newsletter-Management – Abonnenten- und Kampagnenverwaltung via API
  • Ticket-System – Support-Tickets erstellen, aktualisieren und verwalten via API

OAuth2 in 3 Schritten

  1. Client erstellen: Im Backend unter Werkzeuge → xoPort OAuth Clients
  2. Token anfordern: POST an /xpanel/xoport/oauth/token
  3. API nutzen: Token im Header Authorization: Bearer TOKEN