Resell Scan Logo
Resell Scan
Entwickler-Guide

API-Zugang einrichten und nutzen

Integrieren Sie Resell Scan in Ihre Anwendungen. Dieser Guide erklärt wie die API funktioniert, wie Sie sie benutzen und gibt Tipps für Anwendungsfälle.

~15 Minuten
Entwickler
REST API
Voraussetzungen
Was Sie für diesen Guide benötigen
Resell Scan Account (API-Keys im Dashboard generierbar)
Grundkenntnisse in REST APIs
Tool zum Testen von APIs (z.B. Postman, curl)
Wie Sie die API benutzen
Schrittfolge für typische Workflows
  1. API-Key erstellen im Dashboard unter Entwickler → API Zugang.
  2. Sammlungen abrufen mit GET /api/v1/collections (optional page, limit, search).
  3. Produkte listen mit GET /api/v1/collections/{id}/products und Filtern wie include_images=true oder Datumsfiltern.
  4. Produkte anlegen (ohne Analyse) via POST /api/v1/products – z.B. um Bilder hochzuladen und manuelle Felder zu setzen.
  5. Analyse starten (bestehende Produkte) via POST /api/v1/products/analyze mit collectionId und productIds[].
  6. Produkte inline anlegen und analysieren via POST /api/v1/products/createAndAnalyze mit Bild-Uploads (URL oder base64) und optionaler Hintergrundentfernung.
  7. Ergebnisse abrufen via GET /api/v1/products/analyze/{batchId}/results.
Wie die API funktioniert
Architektur, Authentifizierung, Format und Limits
  • Basis-URL: /api/v1 (z.B. https://app.resell-scan.de/api/v1)
  • Authentifizierung: API-Key im Header Authorization: Bearer <API_KEY>
  • Antwortformat: JSON. Fehler enthalten Statuscode und Fehlermeldung.
  • Pagination: page, limit (Standard 20, max. 100)
  • Suche & Filter: Sammlungen unterstützen search; Produkte unterstützen search, include_images sowie Datumsfilter created_after, created_before, updated_after, updated_before (ISO 8601)
  • Dokumentation: Interaktive API-Docs unter /api/v1/docs
1
API-Bereich öffnen

Navigieren Sie im Dashboard zu "Entwickler" → "API Zugang".

Navigation zum API-Bereich
2
API-Key erstellen

Klicken Sie auf "Neuen API-Key erstellen" und geben Sie einen beschreibenden Namen ein.

API-Key erstellen

🔐 Sicherheitshinweis

  • • Der API-Key wird nur einmal vollständig angezeigt
  • • Speichern Sie ihn sicher ab (z.B. in einem Passwort-Manager)
  • • Teilen Sie den Key niemals öffentlich oder in Code-Repositories
  • • Verwenden Sie Umgebungsvariablen in Produktionsanwendungen
3
Ersten API-Aufruf testen

Testen Sie Ihren API-Key mit einem einfachen Aufruf zur Auflistung Ihrer Sammlungen.

cURL Beispiel

curl -X GET https://app.resell-scan.de/api/v1/collections \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

JavaScript Beispiel

const response = await fetch('https://app.resell-scan.de/api/v1/collections', {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
API-Test in Postman
4
Wichtige API-Endpunkte

Übersicht der wichtigsten API-Endpunkte für die Integration:

GET
/api/v1/collections

Alle Sammlungen auflisten

GET
/api/v1/collections/{id}/products

Produkte einer Sammlung abrufen (search, include_images, Datumsfilter)

POST
/api/v1/products

Produkte anlegen (ohne Analyse) – benötigt Permission products:create

POST
/api/v1/products/analyze

Produktanalyse starten (bestehende Produkt-IDs)

POST
/api/v1/products/createAndAnalyze

Produkte anlegen (Bilder hochladen) und Analyse starten

GET
/api/v1/products/analyze/{batchId}

Analysestatus abrufen

GET
/api/v1/products/analyze/{batchId}/results

Analyseergebnisse abrufen

API-Dokumentation

Die vollständige API-Dokumentation mit allen Endpunkten, Parametern und Beispielen finden Sie hier:

API-Dokumentation öffnen
💡 Tipps & Best Practices

Sicherheit

  • • API-Keys in Umgebungsvariablen speichern
  • • HTTPS für alle API-Aufrufe verwenden
  • • Keys regelmäßig rotieren
  • • Separate Keys für verschiedene Umgebungen

Performance

  • • Rate Limits beachten (siehe API-Docs)
  • • Responses cachen wo möglich
  • • Batch-Operationen für mehrere Items nutzen
  • • Pagination für große Datenmengen verwenden

Datenzugriff

  • • Mit search Sammlungen filtern
  • • Produkte inkrementell laden mit created_after/updated_after
  • • Bilder direkt mitliefern via include_images=true

Analyse-Workflows

  • • Für bestehende Produkte: POST /products/analyze
  • • Für neue Produkte mit Bildern: POST /products/createAndAnalyze
  • • Ergebnisse per batchId abrufen und verarbeiten

Weitere Guides entdecken

Zur Guides-Übersicht
Guide abgeschlossen