Modul-Vorstellungen

REST API für Perfex CRM: integrieren & automatisieren mit REST API Pro

Sven Gauditz· 05.07.2026· 6 min
Read this article in English →
REST API für Perfex CRM: integrieren & automatisieren mit REST API Pro

REST API Pro ist ein natives Modul, das Perfex CRM zu einer modernen, entwicklerfreundlichen API-Plattform macht. Es liefert 30 Ressourcen mit vollem CRUD, sichere API-Keys mit Berechtigungen, ausgehende Webhooks und eine eingebaute OpenAPI-Doku. Gedacht für Teams, die Perfex sauber an andere Systeme anbinden und Abläufe automatisieren wollen.

Die mitgelieferte Standard-API von Perfex reicht für ein paar Basisaufrufe, wird aber schnell zur Bremse: Sie deckt nur wenige Ressourcen ab, speichert Keys im Klartext und kennt weder Webhooks noch eine Dokumentation. Wer Perfex ernsthaft integrieren will, stößt an Grenzen. Genau hier setzt REST API Pro an.

Was ist eine REST-API für Perfex CRM – und wozu brauche ich sie?

Eine REST-API ist die Schnittstelle, über die andere Programme mit Ihrem CRM sprechen. Damit lesen und schreiben Sie Kunden, Leads, Rechnungen oder Tickets programmatisch – etwa um Perfex mit einem Buchhaltungssystem, einem Shop, einer eigenen App oder Automatisierungstools wie Zapier und Make zu verbinden. Statt Daten manuell zu übertragen, laufen die Abläufe automatisch.

REST API Pro deckt praktisch das gesamte CRM ab: Kunden und Kontakte, Leads (inklusive der Aktion „In Kunde umwandeln"), Rechnungen, Angebote, Proposals, Gutschriften, Zahlungen, Ausgaben, Projekte, Aufgaben mit Kommentaren und Timern, Verträge, Tickets mit Antworten, Mitarbeiter, Abonnements, Timesheets, Kalender-Events, Artikel und diverse Nachschlagelisten. Jeder Endpunkt liefert eine einheitliche JSON-Hülle mit korrekten HTTP-Statuscodes.

Wie verwalte ich Perfex-API-Keys sicher?

Sicher heißt: Keys werden nur als SHA-256-Hash gespeichert und genau einmal angezeigt – nie im Klartext. Über eine Scope-Matrix vergeben Sie Lese- oder Schreibrechte pro Ressource oder Vollzugriff. Pro Key setzen Sie zusätzlich ein Ablaufdatum, eine IP-Whitelist (einzelne IPs oder CIDR-Bereiche) und ein eigenes Rate-Limit.

Perfex API-Keys mit Scope-Matrix, Ablaufdatum und Status in REST API Pro
Die Key-Verwaltung: gehashte Schlüssel, Berechtigungen pro Ressource, Ablauf und Status auf einen Blick.

Wer strengere Anforderungen hat, tauscht einen Key per POST /v1/auth/token gegen ein kurzlebiges JWT. Das Signatur-Secret ist pro Installation zufällig – anders als bei der Standard-API, die bei allen Kunden dasselbe fest codierte Secret nutzt. Rate-Limiting kommt mit X-RateLimit-*-Headern und sauberen 429-Antworten. So ein Aufruf sieht in der Praxis so aus:

curl https://ihre-domain.tld/rest_api_pro/api/customers?page=1&per_page=50 \
  -H "Authorization: Bearer rap_live_ihr_schluessel"

Perfex-Standard-API vs. REST API Pro

FunktionStandard-APIREST API Pro
Abgedeckte Ressourcenwenige30 mit vollem CRUD
API-KeysKlartext gespeichertSHA-256-Hash, einmalig gezeigt
BerechtigungenkeineScope-Matrix pro Ressource
Rate-Limiting & IP-Whitelistneinja, pro Key
Ausgehende Webhooksnein57 Events, HMAC-signiert
DokumentationkeineOpenAPI 3.1 + Playground
Query-FeatureskaumFilter, Sortierung, Includes, Sync

Wie automatisiere ich Perfex mit Webhooks?

Mit ausgehenden Webhooks schickt Perfex Ereignisse aktiv an andere Systeme, sobald sie passieren. REST API Pro kennt 57 CRM-Events – neue, aktualisierte oder gelöschte Rechnung, bezahlte Rechnung, neuer Lead, umgewandelter Lead, Ticket-Antwort, Task-Statuswechsel und viele mehr – und pusht sie an jeden HTTPS-Endpunkt. Damit binden Sie Perfex ohne Polling an Zapier, Make, Slack oder Ihre eigene Middleware an.

Ausgehende Webhooks in Perfex CRM mit HMAC-Signatur, Zustell-Log und Retry-Status
Webhooks mit Zustell-Log: jede Auslieferung ist HMAC-signiert und wird bei Fehlern automatisch erneut versucht.

Jede Zustellung ist HMAC-signiert (X-Rap-Signature), wird mit exponentiellem Backoff wiederholt und in einem Zustell-Log mit Ein-Klick-Erneut-Senden protokolliert. Ein SSRF-Schutz verhindert Aufrufe an interne Adressen, ein Test-Button prüft einen Webhook sofort.

Muss ich die Perfex-API-Dokumentation selbst schreiben?

Nein. Jeder Endpunkt wird aus einer Live-Spezifikation dokumentiert und kann deshalb nie veralten. Sie bekommen Copy-Paste-Beispiele in cURL, PHP, JavaScript und Python, einen 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.

Interaktive OpenAPI-Dokumentation und Try-it-Playground für die Perfex REST-API
Eingebaute Doku mit Try-it-Playground, Authentifizierungs-Beispielen und Query-Features aus einer Live-Spezifikation.

Auf jedem Listen-Endpunkt stehen mächtige Abfragen bereit: Pagination (?page=2&per_page=50), Filter (?filter[status]=1), Sortierung (?sort=-duedate), Volltextsuche, Sparse Fields, das Einbetten von Relationen (?include=items,payments) und Sync-Fenster (?updated_after=2026-01-01). Dazu kommen Hilfs-Endpunkte wie /search (globale Suche), /stats, /batch (bis zu 25 Operationen pro Request) und ein Request-Log mit Analytics-Dashboard, das Traffic, Fehlerrate, Latenz und Top-Endpunkte zeigt.

Was kostet REST API Pro und welche Voraussetzungen gelten?

REST API Pro gibt es ab 99 € (Regular-Lizenz) für den Einsatz auf einer Domain; die Extended-Lizenz kostet 299 € für den erweiterten Domain-Rahmen. Jede Lizenz enthält 12 Monate Updates und 6 Monate Support, einen sofortigen Lizenzschlüssel und automatische Updates direkt im Admin. Voraussetzungen: Perfex CRM 3.0+, PHP 7.4+ (8.x empfohlen) und die PHP-cURL-Erweiterung.

Der Kauf läuft sicher über Stripe, jedes Modul wird vor der Auslieferung serverseitig auf Malware geprüft. Kommen Sie von der älteren „REST API for Perfex CRM"? Ein Kompatibilitätsmodus bildet deren Header und Response-Shapes nach – der Umstieg sind nur zwei Änderungen: Basis-URL auf /rest_api_pro/api zeigen und einen hier erzeugten Key nutzen.

Häufige Fragen

Ersetzt REST API Pro die eingebaute Perfex-API?

Ja. Es bringt eigene Endpunkte, Keys, Webhooks und Doku mit und deckt deutlich mehr Ressourcen ab. Die Standard-API können Sie parallel weiterlaufen lassen; ein Kompatibilitätsmodus erleichtert zudem den Umstieg von der älteren „REST API for Perfex CRM".

Brauche ich Programmierkenntnisse?

Für die Verwaltung von Keys, Webhooks und Logs nicht – das läuft komplett im Admin. Die Requests selbst richten sich an Entwickler oder Tools wie Zapier und Make. Der eingebaute Playground und die Copy-Paste-Beispiele senken die Hürde deutlich.

Kann ich die API ausprobieren, bevor ich kaufe?

Ja. In der Live-Demo erkunden Sie das komplette Admin, und es gibt öffentliche Read-Only-Endpunkte, die echte JSON-Ausgaben direkt im Browser liefern. Die Demo setzt sich alle 30 Minuten zurück.

Sind die API-Keys sicher gespeichert?

Ja. Keys werden nur als SHA-256-Hash gespeichert und genau einmal angezeigt. Zusätzlich gibt es Berechtigungen pro Ressource, IP-Whitelist, Ablaufdatum und ein Rate-Limit pro Key.

Funktioniert das mit Zapier und Make?

Ja. Ausgehende Webhooks pushen 57 CRM-Events an jeden HTTPS-Endpunkt, HMAC-signiert und mit automatischen Retries. Für Abfragen und Schreibzugriffe stehen alle Ressourcen als REST-Endpunkte bereit.

Wie bekomme ich Updates und Support?

Jede Lizenz enthält 12 Monate Updates und 6 Monate Support. Updates spielen Sie über den Lizenzschlüssel direkt im Admin ein. Details finden Sie im Hilfe-Center.

Jetzt starten

Wenn Sie Perfex sauber integrieren und automatisieren wollen, führt an einer richtigen REST-API kein Weg vorbei. Sehen Sie sich REST API Pro auf der Produktseite an, testen Sie die Endpunkte in der Live-Demo und stöbern Sie bei Bedarf im gesamten Modul-Katalog. Nach dem Kauf über die Produktseite erhalten Sie sofort Ihren Lizenzschlüssel und legen los.