REST API Pro

REST API Pro — Ihr ganzes CRM, eine saubere API

REST API Pro macht aus Perfex CRM eine moderne, entwicklerfreundliche API-Plattform. 30 Ressourcen mit vollem CRUD, gehashte & berechtigungsbeschränkte API-Schlüssel, JWT, Rate-Limiting, ein durchsuchbares Request-Log mit Analytics-Dashboard, ausgehende Webhooks, eine maschinenlesbare OpenAPI-3.1-Spezifikation und eine eingebaute interaktive Dokumentation mit Try-it-Playground — alles, was die Standard-API nie hatte, in einem nativen, wunderschön gestalteten Modul.

▶ Live ansehen & die API selbst testen

Erkunden Sie das komplette Admin in der öffentlichen Demo (Login demo / demo123):

• Live-Demo — API-Dashboard, Schlüssel, Webhooks, Logs & Doku
• Live-Dokumentation mit Try-it-Playground

Oder rufen Sie die Live-API direkt im Browser auf (Read-Only-Demo-Schlüssel, echte JSON-Ausgabe):

• GET /v1/ping — Health-Check (kein Schlüssel nötig)
• GET /customers — Kunden auflisten
• GET /invoices — Rechnungen auflisten
• GET /leads/search/Skyline — Leads durchsuchen

So funktioniert's (geführter Rundgang)

Was die API kann — 30 Ressourcen, volles CRUD

Jeder Endpunkt liefert eine einheitliche JSON-Hülle mit korrekten HTTP-Statuscodes. Ressourcen mit vollem Anlegen / Lesen / Aktualisieren / Löschen:

• Kunden (inkl. Rechnungs- & Lieferadresse, Gruppen) und Kontakte
• Leads (Status, Quelle, Wert, Tags) — plus Aktion In Kunde umwandeln
• Rechnungen — Anlegen mit einfachem items[]-Array; Summen, Steuer und Rechnungsnummer werden automatisch abgeleitet. Inkl. Unter-Sammlungen /items und /payments
• Angebote (mit In Rechnung umwandeln), Proposals, Gutschriften
• Zahlungen — volles CRUD (die Standard-API konnte nur Anlegen)
• Ausgaben (abrechenbar, wiederkehrend), Projekte (Mitglieder, Meilensteine, Aufgaben, Diskussionen)
• Aufgaben — plus Kommentare und Timer (Start / Stopp)
• Meilensteine, Verträge, Tickets (mit Antworten)
• Mitarbeiter, Abonnements, Timesheets, Kalender-Events
• Artikel — volles CRUD (in der Standard-API nur lesbar), Artikelgruppen
• Steuern, Währungen, Zahlungsarten, Ausgaben-Kategorien, Abteilungen
• Notizen, Wissensdatenbank, Ankündigungen, Aktivitätslog sowie Nachschlagelisten (Lead-Quellen/-Status, Vertragstypen, Tags)

Aktions-Endpunkte: Rechnungs- / Angebots- / Proposal- / Gutschrift-PDF herunterladen, Dokument per E-Mail versenden, Angebot→Rechnung und Lead→Kunde umwandeln, Task-Kommentare, Task-Timer starten/stoppen, Ticket-Antworten und Anhänge hoch-/herunterladen (Base64-JSON — funktioniert auch dort, wo Multipart blockiert ist).

Hilfs-Endpunkte: /ping (Health), /me (Schlüssel-Info), /search?q= (globale Suche über 12 Ressourcen), /stats (CRM-Kennzahlen), /batch (bis zu 25 Operationen in einem Request) und /openapi.json (die vollständige Spezifikation).

Mächtige Abfragen auf jedem Listen-Endpunkt

Kein „alle Zeilen laden" mehr. Jeder Listen-Endpunkt unterstützt:

• Pagination: ?page=2&per_page=50 (sauberer meta-Block mit Gesamtzahlen)
• Filter: ?filter[status]=1&filter[clientid]=7 (kommagetrennte Werte werden zu IN())
• Sortierung: ?sort=-duedate
• Volltextsuche: ?search=acme
• Sparse Fields: ?fields=company,city
• Relationen einbetten: ?include=items,payments
• Sync-Fenster: ?updated_after=2026-01-01

Sicherheit richtig gemacht

• Gehashte Schlüssel: API-Schlüssel werden nur als SHA-256-Hash gespeichert und genau einmal angezeigt — nie im Klartext (die Standard-API speichert und zeigt sie im Klartext).
• Scope-Matrix: Lesen / Schreiben je Ressource vergeben — oder Vollzugriff.
• Pro-Schlüssel-Kontrollen: Ablaufdatum, IP-Whitelist (einzelne IPs oder CIDR-Bereiche) und ein Rate-Limit pro Schlüssel.
• JWT-Secret pro Installation: Schlüssel gegen ein kurzlebiges JWT tauschen via POST /v1/auth/token; das Signatur-Secret ist pro Installation zufällig (die Standard-API nutzt ein bei allen Kunden identisches, fest codiertes Secret).
• Rate-Limiting mit X-RateLimit-*-Headern und sauberen 429-Antworten.

Eingebaute Dokumentation & Playground

Jeder Endpunkt wird aus einer Live-Spezifikation dokumentiert — sie kann nie veralten. Copy-Paste-Beispiele in cURL, PHP, JavaScript und Python, ein Try-it-Playground für echte Requests direkt aus dem Admin und eine herunterladbare OpenAPI-3.1-Datei für Postman, Insomnia, Code-Generatoren oder GPT-Actions.

Ausgehende Webhooks (Zapier & Make)

Pushen Sie 57 CRM-Events — neue/aktualisierte/gelöschte Rechnung, bezahlte Rechnung, neuer Lead, umgewandelter Lead, Ticket-Antwort, Task-Statuswechsel und viele mehr — an jeden HTTPS-Endpunkt. Jede Zustellung ist HMAC-signiert (X-Rap-Signature), wird mit exponentiellem Backoff wiederholt, in einem Zustell-Log mit Ein-Klick-Erneut-Senden protokolliert und durch einen SSRF-Schutz abgesichert. Ein Test-Button prüft einen Webhook sofort.

Request-Log & Analytics

Jeder Aufruf wird mit Methode, Pfad, Status, Latenz, IP und (optional) einem Secret-maskierten Payload-Auszug protokolliert. Das Dashboard zeigt Traffic-Chart, Fehlerrate, Ø-Latenz, Top-Endpunkte und Top-Schlüssel. Die Aufbewahrung ist konfigurierbar und wird automatisch bereinigt.

Einstellungen, Health-Check & responsives Design

Ein eingebauter Health-Check prüft Lizenz, cURL, Cron und CSRF-Konfiguration und liefert bei Bedarf den exakten Ein-Zeilen-Fix. Das gesamte Admin ist voll responsiv und im nativen Perfex-Look.

Umstieg von einer anderen Perfex-API?

REST API Pro bringt einen Kompatibilitätsmodus, der die Request-Konventionen und Response-Shapes der älteren „REST API for Perfex CRM" nachbildet (Legacy-Header authtoken / X-API-KEY, rohe Array-GET-Antworten, {status, message} beim Schreiben). Der Umstieg sind nur zwei Änderungen: Basis-URL auf /rest_api_pro/api zeigen und einen hier erzeugten Schlüssel nutzen.

Auf einen Blick

• 30 Ressourcen, volles CRUD, einheitliche JSON-Hülle & korrekte Statuscodes
• Gehashte & berechtigte API-Schlüssel, JWT, Rate-Limits pro Schlüssel, IP-Whitelist, Ablauf
• Pagination, Filter, Sortierung, Sparse Fields, Includes, Sync-Fenster
• 57-Event-Webhooks (HMAC, Retries, Zustell-Log, SSRF-Schutz)
• Request-Log + Analytics-Dashboard
• OpenAPI 3.1 + eingebaute interaktive Doku & Playground
• Batch, globale Suche, Stats, PDF- / Versand- / Umwandlungs- / Timer- / Anhang-Aktionen
• Referenz-Kompatibilitätsmodus, CSRF-sichere Schreibzugriffe (POST & PUT)
• Vollständig Deutsch & Englisch, nativer Perfex-Look, voll responsiv

Voraussetzungen

Perfex CRM 3.0+, PHP 7.4+ (8.x empfohlen), PHP-cURL-Erweiterung.

Support & Roadmap

Fehler gefunden oder eine Feature-Idee für REST API Pro? Nutzen Sie unseren öffentlichen Bug-Tracker — Fehler melden (gern mit Screenshots), über Features abstimmen und die Roadmap verfolgen:

• Öffentlicher Bug-Tracker & Roadmap
• Fehler melden

Copyright © Sven Gauditz - PixAgentur.com — Alle Rechte vorbehalten.