Platform API¶
Uebersicht¶
Die xynap Platform API ist eine FastAPI-Anwendung mit 777 REST-Endpoints auf 580 Pfaden.
- Base URL:
https://platform.xynap.tech/api/v1/ - OpenAPI Docs:
https://platform.xynap.tech/api/v1/docs - OpenAPI JSON:
https://platform.xynap.tech/api/v1/openapi.json
Technologie¶
| Komponente | Version |
|---|---|
| FastAPI | >= 0.115 |
| SQLAlchemy | 2.0 (async) |
| MariaDB | 11.4 |
| Redis | 7 |
| Alembic | >= 1.13 |
| Python | 3.12 |
Deployment¶
Die API laeuft in zwei Modi:
- Docker (Port 8099) — fuer Traefik/Web-Zugriff
- systemd (Port 8001) — fuer FreeSwitch xml-curl
RBAC-System¶
5 Rollen mit 30+ granularen Permissions:
| Rolle | Beschreibung |
|---|---|
superadmin |
Voller Zugriff |
admin |
Verwaltung (ohne System-Config) |
reseller |
Kundenverwaltung |
customer |
Eigene Ressourcen |
viewer |
Nur Lesen |
Permissions folgen dem Schema modul.aktion, z.B.:
domains.read,domains.create,domains.update,domains.deletedomains.manage_dns— DNS-Records verwaltenhosting.sites.read,hosting.sites.createmail.domains.read,mail.accounts.createsystem.read,system.write
API-Gruppen¶
| Prefix | Endpoints | Beschreibung |
|---|---|---|
/auth/ |
29 | Login, 2FA, Session |
/oauth/ |
4 | OAuth2 Flows |
/users/ |
11 | Benutzerverwaltung |
/customers/ |
10 | Kundenverwaltung |
/contacts/ |
10 | Kontakte (Shared) |
/domains/ |
19 | Domains, DNS, Verify |
/dns-providers/ |
7 | Provider CRUD, Test |
/billing/ |
15 | Rechnungen, Positionen |
/payments/ |
5 | Payment Webhooks |
/projects/ |
12 | Abos, Projekte |
/packages/ |
10 | Produkt-Pakete |
/tickets/ |
6 | Support-Tickets |
/support/ |
20 | Support-Workflows |
/monitoring/ |
7 | Health, Metriken |
/security/ |
4 | CrowdSec |
/backups/ |
9 | Schedules, Trigger |
/hosting/ |
10 | Sites, Databases |
/mail/ |
16 | Domains, Accounts, Aliase |
/sip/ |
40 | Trunks, Extensions, DID, WebRTC |
/workflows/ |
18 | Workflow-Engine |
/genesis/ |
9 | AI-Agent Tasks |
/crm/ |
125 | Deals, Rechnungen, Belege, Kalender, Templates, Themes |
/cms/ |
68 | Sites, Pages, Templates, Media |
/self-service/ |
24 | Kunden-Portal |
/onboarding/ |
2 | Self-Service Checkout |
/ssl/ |
8 | ACME, Zertifikate |
/tenants/ |
12 | Multi-Tenant SaaS |
/infrastructure/ |
7 | Server, VMs |
/notifications/ |
5 | Benachrichtigungen |
/favorites/ |
4 | Favoriten |
/settings/ |
5 | System-Einstellungen |
/audit/ |
3 | Audit-Log |
/search/ |
1 | Globale Suche |
/fonts/ |
7 | Schriftverwaltung |
/storage/ |
2 | Speicher-Quota |
/comm/ |
6 | Kommunikation (Call, Telegram, Voice, Notify, Health) |
/coder/ |
4 | Coder-Engine |
/provisioning/ |
4 | Server-Provisioning |
/blocklist/ |
1 | IP/Domain Blocklist |
/ocr/ |
4 | Dokumentenerkennung (Mistral OCR) |
/system/ |
5 | Services, Orchestrator |
Background-Services¶
Die API startet automatisch mehrere Background-Worker:
| Worker | Intervall | Beschreibung |
|---|---|---|
| Monitoring | 5 Min | Container-Health, Disk, SSL-Expiry |
| Backup-Scheduler | 60 Sek | Cron-basierte Backup-Trigger |
| DNS-Verification | 5 Min | Prueft DNS fuer unverified Domains |
| Genesis Listener | Permanent | Redis PubSub fuer AI-Agent |