API-Dokumentation

Einführung

Die monekey REST API ermöglicht es Ihnen, Dossiers, Dokumente, externe Nutzer und Aufgaben programmatisch zu verwalten. Sie eignet sich für die Integration in bestehende Softwarelösungen, automatisierte Import-Pipelines und Custom-Frontends.

API-Zugang ist ab dem Business-Plan verfügbar. Für Enterprise steht eine dedizierte Sandbox-Umgebung zur Verfügung.

Authentifizierung

Alle API-Anfragen müssen mit einem Bearer-Token authentifiziert werden. API-Keys können unter Einstellungen → Integrationen → API Keys generiert werden.

http

Authorization: Bearer sk_live_AbCdEfGhIjKlMnOpQrStUvWxYz1234567890
Content-Type: application/json
X-Organization-ID: org_xxxxxxxxxxxxxxxx

sk_live_...

Live Key

Für Produktionsdaten. Sorgfältig verwahren.

sk_test_...

Test Key

Für Entwicklung und Tests. Keine echten Daten.

Base URL & Versionen

url

# Produktion
https://api.monekey.ch/v1

# Sandbox (Enterprise)
https://sandbox.api.monekey.ch/v1

Die API-Version wird im URL-Pfad angegeben. Wenn eine neue Version veröffentlicht wird, wird die Vorgängerversion noch mindestens 12 Monate unterstützt.

Fehlercodes

200OKAnfrage erfolgreich

201CreatedRessource erfolgreich erstellt

400Bad RequestUngültige Parameter oder fehlende Pflichtfelder

401UnauthorizedFehlender oder ungültiger API Key

403ForbiddenKeine Berechtigung für diese Aktion

404Not FoundRessource nicht gefunden

422UnprocessableValidierungsfehler – Details im Response-Body

429Too Many RequestsRate Limit überschritten

500Server ErrorInterner Fehler – bitte Support kontaktieren

json

{
  "error": {
    "code": "DOCUMENT_NOT_FOUND",
    "message": "Document with ID doc_xyz not found",
    "status": 404
  }
}

Endpoints

GET/v1/dossiersAlle Dossiers der Organisation auflisten

POST/v1/dossiersNeues Dossier anlegen

GET/v1/dossiers/{id}Einzelnes Dossier abrufen

PUT/v1/dossiers/{id}Dossier aktualisieren

DELETE/v1/dossiers/{id}Dossier archivieren

GET/v1/dossiers/{id}/documentsAlle Dokumente eines Dossiers

POST/v1/dossiers/{id}/documentsDokument hochladen (multipart/form-data)

GET/v1/documents/{id}Dokument-Metadaten abrufen

GET/v1/documents/{id}/downloadSignierte Download-URL generieren

DELETE/v1/documents/{id}Dokument archivieren

GET/v1/portal/usersExterne Nutzer auflisten

POST/v1/portal/inviteNutzer per E-Mail einladen

POST/v1/portal/invite/qrQR-Code Einladung generieren

DELETE/v1/portal/users/{id}Zugang eines Nutzers widerrufen

GET/v1/tasksAufgaben auflisten (filter: status, due)

POST/v1/tasksNeue Aufgabe erstellen

PATCH/v1/tasks/{id}Aufgabe aktualisieren (Status, Fälligkeit)

DELETE/v1/tasks/{id}Aufgabe löschen

GET/v1/audit-logAudit-Einträge abrufen (paginiert)

GET/v1/audit-log/exportAudit Log als CSV exportieren

Webhooks

Webhooks werden als HTTP POST-Request an Ihre URL gesendet, sobald ein Ereignis eintritt. Signatur-Verifizierung via HMAC-SHA256.

document.uploaded

document.deleted

dossier.created

portal.user_invited

portal.user_accessed

task.due_soon

json

// POST https://your-server.com/webhooks/monekey
{
  "event": "document.uploaded",
  "created_at": "2026-03-03T10:31:00Z",
  "data": {
    "document_id": "doc_01j9xkmp2vhfq8nz7c3b",
    "dossier_id": "dos_01j9xkmp2vhfq8nz7c3a",
    "uploaded_by": "user_intern_xxx",
    "category": "rental_contract"
  }
}

Rate Limiting

Business1'000 req / StundeBurst: 100 req / Minute

Enterprise10'000 req / StundeBurst: 500 req / Minute

Bei Überschreitung wird ein 429-Status zurückgegeben. Response-Header X-RateLimit-Remaining zeigt verbleibende Anfragen.

SDKs & Libraries

⚡

JavaScript / Node.js

Q2 2026

🐍

Python

Q3 2026

🐘

PHP

Q4 2026

Bis zur SDK-Veröffentlichung empfehlen wir direkte REST-Aufrufe via fetch, axios oder curl.

monekey API Dokumentation