API-Einführung

Willkommen bei der Curosa API v1

Die Curosa-API ermöglicht es Ihnen, Ihr Lieferantenkonto, Ihre Produkte, Bestellungen und Bestände programmatisch zu verwalten. Unsere REST-API verwendet Standard-HTTP-Methoden und liefert JSON-Antworten zurück.

Basis-URL

Das Live-System ist erreichbar unter

https://curosa.com/api/v1

Authentifizierung

Die Curosa-API verwendet API-Token zur Authentifizierung. Sie können einen API-Token generieren, indem Sie den Authentifizierungs-Endpunkt mit der E-Mail-Adresse und dem Passwort Ihres Lieferantenportals aufrufen.

Fehlerbehandlung

Wenn ein Fehler auftritt, gibt die API einen entsprechenden HTTP-Statuscode und Fehlerdetails zurück:

Format der Fehlermeldung:

{
  "error": {
    "code": "invalid_parameter",
    "message": "The 'sku' field is required",
    "field": "sku"
  }
}

Paginierung

Listen-Endpunkte verwenden eine Cursor-basierte Paginierung für eine effiziente Navigation durch große Datensätze. Die Cursor-basierte Paginierung bietet eine bessere Leistung und Konsistenz, wenn Daten häufig aktualisiert werden.

Seiten abrufen

Um die nächste Ergebnisseite abzurufen, verwenden Sie den Abfrageparameter cursor mit dem Wert aus dem Feld meta.next_cursor der vorherigen Antwort:

curl --location 'https://curosa.com/api/v1/products?cursor=eyJwcm9kdWN0cy5pZCI6MTAwLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9' \
--header 'Authorization: Bearer DEIN_API_TOKEN'

Format der paginierten Antwort

Paginierte Antworten enthalten Navigationslinks und Metadaten:

{
  "data": [
    {
      "sku": "T3272P287613",
      "platform_sku": "367.983.903",
      "name": "Example Product"
    }
  ],
  "links": {
    "first": null,
    "last": null,
    "prev": null,
    "next": "https://curosa.com/api/v1/products?cursor=eyJwcm9kdWN0cy5pZCI6MTAwLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
  },
  "meta": {
    "path": "https://curosa.com/api/v1/products",
    "per_page": 100,
    "next_cursor": "eyJwcm9kdWN0cy5pZCI6MTAwLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
    "prev_cursor": null
  }
}

Antwortfelder:

• links: Navigationslinks für die Paginierung
  • first: Link zur ersten Seite (normalerweise null bei Cursor-basierter Paginierung)
  • last: Link zur letzten Seite (normalerweise null bei Cursor-basierter Paginierung)
  • prev: Link zur vorherigen Seite (verwenden Sie meta.prev_cursor, falls verfügbar)
  • next: Link zur nächsten Seite (verwenden Sie meta.next_cursor, falls verfügbar)
• meta: Metadaten zur Paginierung
  • path: Der Basispfad für diesen Endpunkt
  • per_page: Anzahl der Elemente pro Seite (variiert je nach Endpunkt)
  • next_cursor: Cursor-Token für die nächste Seite (zur Verwendung im Abfrageparameter cursor)
  • prev_cursor: Cursor-Token für die vorherige Seite (zur Verwendung im Abfrageparameter cursor oder null, wenn man sich auf der ersten Seite befindet)

Navigieren durch die Seiten

• Erste Seite: Stellen Sie eine Anfrage ohne den Parameter cursor.
• Nächste Seite: Verwenden Sie den Wert meta.next_cursor im Abfrageparameter cursor.
• Vorherige Seite: Verwenden Sie den Wert meta.prev_cursor im Abfrageparameter cursor (falls verfügbar).
• Keine weiteren Seiten: Wenn meta.next_cursor gleich null ist, haben Sie das Ende der Ergebnisse erreicht.

Nächste Schritte

• Authentifizierung – Erfahren Sie, wie Sie Ihren API-Token erhalten und verwenden.
• Ratenbegrenzung – Informationen zu Ratenbegrenzungen und Best Practices.
• Produkte – Verwalten Sie Ihren Produktkatalog.