Wie migriere ich von der alten REST API for Perfex CRM (Kompatibilitätsmodus)?

Du hast schon eine Integration gegen die ältere "REST API for Perfex CRM" gebaut? Dann musst du nicht bei null anfangen. REST API Pro bringt einen Kompatibilitätsmodus mit, der die Anfrage-Konventionen und Antwortformen der alten API nachbildet. So kannst du bestehende Anbindungen mit minimalem Aufwand umziehen und danach Schritt für Schritt auf die modernen /v1 -Endpunkte umstellen.

🔁 Was der Kompatibilitätsmodus bietet

Unter dem Pfad /rest_api_pro/api reagiert das Modul wie die alte API, mit den gleichten "rohen" Antwortformen (Arrays und Objekte statt der neuen Envelope):

GET /rest_api_pro/api/ Liste (rohes Array) GET /rest_api_pro/api// ein Datensatz GET /rest_api_pro/api//search/ Suche POST /rest_api_pro/api/ anlegen PUT /rest_api_pro/api// aktualisieren DELETE /rest_api_pro/api// loeschen

Auch die alte Authentifizierung wird akzeptiert: die Header authtoken bzw. X-API-KEY sowie der Parameter ?key= , jeweils mit einem hier erzeugten REST-API-Pro-Key.

🧭 Migration in zwei Schritten

Ändere die Basis-URL deiner Integration von .../api auf .../rest_api_pro/api .
Erzeuge in REST API Pro einen API-Key und verwende diesen (die alten Tokens gelten hier nicht).

Mehr ist für den Umzug in der Regel nicht nötig. Lesende Anfragen funktionieren sofort out of the box.

⚠️ Wichtiger Hinweis zum Pfad

Perfex leitet die URLs eines Moduls nur dann weiter, wenn das erste Pfadsegment dem Modulordner entspricht. Deshalb lässt sich das wörtliche /api -Präfix der alten API nicht ohne Eingriff in Kern-Dateien übernehmen, dein neuer Präfix ist /rest_api_pro/api .

✉️ Schreibende Aufrufe & CSRF

Alte POST-Schreibvorgänge brauchen die CSRF-Ausnahme, falls dein Perfex den CSRF-Schutz aktiv hat. Der Health-Check auf der Einstellungsseite erkennt das und bietet dir den offiziellen Einzeiler an, mit dem du POSTs freischaltest, ganz ohne Kern-Dateien zu ändern. Lesende Aufrufe sind davon nicht betroffen.

🎯 Empfehlung

Nutze den Kompatibilitätsmodus als Brücke: erst umziehen, damit alles weiterläuft, dann bei Gelegenheit auf die moderne /v1 -API mit Paging, Filtern, Scopes und Webhooks umstellen, um alle Vorteile von REST API Pro voll auszuschöpfen.