API Overview

Das Perfex CRM SaaS Module enthält eine REST API, mit der Sie Ihre SaaS-Plattform programmatisch verwalten können. Dies ist nützlich für:

• Benutzerdefinierte Registrierungsseiten – Eigenen Registrierungsablauf erstellen
• Drittanbieter-Integrationen – Verbindung mit externen Tools (Zapier, Integromat, eigene Apps)
• Abrechnungs-Automatisierung – Synchronisation mit externen Abrechnungssystemen
• Monitoring – Benutzerdefinierte Dashboards und Monitoring-Tools erstellen
• Mobile Apps – Mobile Verwaltungsoberflächen erstellen

Getting Started with the API

Step 1: Enable the API

1. Gehen Sie zu SaaS Management → SuperAdmin Settings
2. Klicken Sie auf die Registerkarte API Settings
3. Schalten Sie die API auf ON
4. Generieren Sie einen API-Token

Step 2: Authentication

Alle API-Anfragen erfordern Authentifizierung über einen Bearer-Token im Request-Header:

Authorization: Bearer YOUR_API_TOKEN_HERE

Step 3: Base URL

Ihre API-Basis-URL lautet:

https://yoursite.com/api/saas/

Ersetzen Sie yoursite.com durch Ihre tatsächliche Domain.

---

Quick Example

Hier ein kurzes Beispiel zur Erstellung eines Tenants über die API:

curl -X POST https://yoursite.com/api/saas/tenants \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "company_name": "Acme Corp",
    "email": "[email protected]",
    "first_name": "John",
    "last_name": "Doe",
    "plan_id": 1,
    "subdomain": "acme"
  }'

Response:

{
  "success": true,
  "tenant_id": 42,
  "domain": "acme.yoursite.com",
  "message": "Tenant created successfully"
}

---

API Capabilities

Endpoint Group	What You Can Do
Tenants	Tenants erstellen, lesen, aktualisieren, löschen
Plans	Pläne auflisten, erstellen, aktualisieren
Subscriptions	Tenant-Abonnements verwalten
Usage	Tenant-Nutzung und Kontingente abfragen

Die vollständige Liste der Endpunkte finden Sie in der API Reference.

---

Rate Limiting

Die API implementiert Rate Limiting zum Schutz Ihres Servers:

• 100 Anfragen pro Minute pro API-Token
• Rate-Limit-Header sind in jeder Antwort enthalten

Bei Überschreitung des Limits erhalten Sie eine Antwort 429 Too Many Requests.

---

Best Practices

1. API-Token geheim halten – Niemals in clientseitigem Code oder öffentlichen Repositories preisgeben
2. HTTPS verwenden – API-Anfragen immer über HTTPS stellen
3. Fehler sinnvoll behandeln – Statuscodes prüfen und Fehler angemessen behandeln
4. Caching nutzen – Dieselben Daten nicht wiederholt abfragen; Antworten cachen, wenn sie sich selten ändern

info

Benutzerdefinierte Integration nötig? Wenn die API Ihren Anwendungsfall nicht abdeckt, kontaktieren Sie uns über support. Wir erweitern die API ständig basierend auf Kundenfeedback.

API Reference