API-Dokumentation

Erfahren Sie, wie Sie die Mercozy-API integrieren, um Produkte, Bestellungen, Bestaende und mehr zu verwalten.

Erste Schritte
1
API-Schluessel erhalten

Melden Sie sich als Admin an und gehen Sie zu Einstellungen > Integration > API-Schlüssel um einen neuen Schlüssel zu generieren. Nur Admin-Benutzer haben die Berechtigung.

2
In Anfragen einbinden

Fuegen Sie den X-API-Key-Header zu allen Ihren API-Anfragen hinzu.

3
Anfragen senden

Verwenden Sie einen beliebigen HTTP-Client, um mit den Mercozy-API-Endpunkten zu interagieren.

Authentifizierung

Alle API-Anfragen erfordern einen gueltigen API-Schluessel, der ueber den X-API-Key-Header gesendet wird.

bash
curl https://api.mercozy.com/api/v1/external/products \
  -H "X-API-Key: mk_live_your_key_here"
Basis-URL
https://api.mercozy.com/api/v1/external
Ratenbegrenzungen

API-Ratenbegrenzungen haengen von Ihrem Abonnementplan ab.

PlanRatenbegrenzungAPI-Zugang
Free / StandardKein API-Zugang
No
Pro300 Anf/Min
Yes
Business1,000 Anf/Min
Yes
Antwortformat

Alle Antworten werden im JSON-Format zurueckgegeben.

Erfolgreiche Antwort
json
{
  "data": [
    {
      "id": "prod_abc123",
      "name": "Premium Widget",
      "price": 2999,
      "currency": "USD"
    }
  ],
  "meta": {
    "total": 42,
    "page": 1,
    "limit": 20
  }
}
Fehlerantwort
json
{
  "statusCode": 401,
  "message": "Invalid API key",
  "error": "Unauthorized"
}
Fehlercodes
CodeStatusBeschreibung

VALIDATION_ERROR

400

Ungueltige Anfrageparameter

UNAUTHORIZED

401

Ungueltiger oder fehlender API-Schluessel

FORBIDDEN

403

Unzureichende Berechtigungen

NOT_FOUND

404

Ressource nicht gefunden

CONFLICT

409

Ressource existiert bereits oder Konflikt

RATE_LIMITED

429

Zu viele Anfragen

INTERNAL_ERROR

500

Interner Serverfehler