Wiri Connect API

Eine leseorientierte REST API zum Abrufen Ihrer Wiri-Daten in Drittanbietersysteme, Dashboards und Integrationen. Verfügbar in Enterprise-Plänen.

Nur Enterprise. Die Wiri Connect API ist im Enterprise-Plan verfügbar. Um einen API-Schlüssel zu generieren, gehen Sie zu Einstellungen → API-Zugang in Ihrem Wiri-Konto.

Authentifizierung

Jede Anfrage muss Ihren API-Schlüssel im Authorization-Header als Bearer-Token enthalten:

# Beispiel mit curl
curl https://ihre-domain.com/api/v1/items \
  -H "Authorization: Bearer wk_ihr_api_schluessel_hier"

Wenn der Schlüssel fehlt oder ungültig ist, gibt die API 401 Unauthorized zurück:

{
  "error": "Invalid API key."
}

Basis-URL

Alle Endpunkte sind relativ zu Ihrem Wiri-Installationsstamm:

https://ihre-domain.com/api/v1/

Endpunkte

Methode	Endpunkt	Beschreibung
GET	`/api/v1/items`	Alle Menüartikel auflisten
GET	`/api/v1/contacts`	Alle Kunden / Kontakte auflisten
GET	`/api/v1/invoices`	Rechnungen auflisten — unterstützt `?status`, `?from`, `?to`
GET	`/api/v1/sales`	Kassensystem-Verkäufe auflisten — unterstützt `?status`, `?from`, `?to`

Antwortformat

Alle erfolgreichen Antworten geben 200 OK mit einem JSON-Body zurück, der zwei Felder enthält:

{
  "data": [ /* Array von Objekten */ ],
  "count": 42
}

GET /api/v1/items

Gibt alle Menüartikel Ihres Kontos zurück, alphabetisch geordnet.

# Anfrage
curl https://ihre-domain.com/api/v1/items \
  -H "Authorization: Bearer wk_..."

# Antwort
{
  "data": [
    {
      "id": 1,
      "name": "Jollof Rice",
      "rate": "45.00",
      "unit": "plate",
      "description": null,
      "category": 3
    }
  ],
  "count": 1
}

GET /api/v1/contacts

Gibt alle Kontakte (Kunden) Ihres Kontos zurück, nach Name geordnet.

# Antwort
{
  "data": [
    {
      "id": 12,
      "display_name": "Ama Owusu",
      "email": "ama@example.com",
      "mobile": "+233201234567",
      "address": null,
      "type": "individual",
      "created_at": "2026-01-15 09:22:00"
    }
  ],
  "count": 1
}

GET /api/v1/invoices

Gibt Rechnungen in absteigender Datumsreihenfolge zurück. Unterstützt folgende Abfrageparameter:

Parameter	Typ	Beispiel	Beschreibung
`status`	string	`Paid`	`Paid`, `Unpaid` oder `Overdue`
`from`	Datum	`2026-01-01`	Beginn des Datumsbereichs (einschließlich)
`to`	Datum	`2026-01-31`	Ende des Datumsbereichs (einschließlich)

# Alle bezahlten Rechnungen für Januar 2026 abrufen
curl "https://ihre-domain.com/api/v1/invoices?status=Paid&from=2026-01-01&to=2026-01-31" \
  -H "Authorization: Bearer wk_..."

GET /api/v1/sales

Gibt Kassensystem-Verkäufe in absteigender Datumsreihenfolge zurück. Unterstützt dieselben Abfrageparameter wie Rechnungen, mit status akzeptiert paid oder voided.

# Alle Verkäufe eines Tages abrufen
curl "https://ihre-domain.com/api/v1/sales?from=2026-07-01&to=2026-07-01" \
  -H "Authorization: Bearer wk_..."

Fehlerantworten

HTTP-Status	Body	Wann
`401`	`{"error": "Invalid API key."}`	Schlüssel fehlt, falsch oder widerrufen
`401`	`{"error": "Missing or malformed Authorization header."}`	Header fehlt oder nicht im Bearer-Format
`404`	`{"error": "Unknown endpoint."}`	Ressourcenname nicht in der erlaubten Liste

API-Schlüssel generieren

Melden Sie sich in Ihrem Wiri-Konto an (Enterprise-Plan erforderlich).
Gehen Sie zu Einstellungen → API-Zugang.
Klicken Sie auf API-Schlüssel generieren. Ihr Schlüssel beginnt mit wk_.
Kopieren Sie den Schlüssel sofort — er wird nach der Generierung nur einmal vollständig angezeigt.
Um den Schlüssel zu rotieren, klicken Sie auf Schlüssel neu generieren. Der alte Schlüssel hört sofort auf zu funktionieren.

Halten Sie Ihren Schlüssel geheim. Jeder mit Ihrem API-Schlüssel kann alle Ihre Geschäftsdaten lesen. Committen Sie ihn nicht in die Versionskontrolle oder stellen Sie ihn nicht in clientseitigem Code bloß.

Verwandt: Einstellungen · Wiri Connect Übersicht