Supplier Portal API

API Dokumentation

REST API fuer Supplier-, Preis-, Bestell- und Admin-Funktionen. Alle fachlichen Endpunkte verwenden JSON und API-Key-Authentifizierung per Bearer Token.

Getting started

Die API ist unter derselben Host-Basis wie das Supplier Portal erreichbar. Beispiele verwenden https://supplier-portal.example.com als Platzhalter. 

curl -H "Authorization: Bearer <api_key>" \
     -H "Accept: application/json" \
     https://supplier-portal.example.com/api/v1/products?limit=10

Content-type

Requests mit Body senden Content-Type: application/json. Responses werden als JSON ausgeliefert.

Accept language

Die aktuelle API lokalisiert Response-Inhalte nicht. Clients koennen Accept-Language senden; die fachlichen Daten bleiben unveraendert.

Query parameters

Listen-Endpunkte akzeptieren je nach Ressource Filter. limit ist auf 1 bis 200 begrenzt und faellt ohne Angabe auf 50 zurueck.

Authentication

Alle Endpunkte ausser GET /health erwarten Authorization: Bearer <api_key>. Der API-Key wird serverseitig gehasht und einem aktiven User-Token mit Scopes zugeordnet.

Scope Berechtigung
products:readProdukte, Varianten, Kategorien und Attribute lesen
prices:readUsergroups, Preislisten und Preise lesen
prices:writePreislisten und Preispositionen schreiben
orders:readBestellungen und Bestellpositionen lesen
billing:readBilling, Invoices und Sales lesen
admin:readAdmin-Ansichten und globale Supplier-Filter lesen

Documentation maintenance

Sobald sich die API aendert, muss diese Dokumentation im selben Change automatisch mit angepasst werden. Der Check python3 scripts/check-api-docs.py vergleicht die FastAPI-Routen mit den hier dokumentierten Endpunkten und sollte vor jedem Merge laufen.

Resources