Sidefish Documentatie
Welkom bij de officiële documentatie van het Sidefish Platform.
De documentatie is opgesplitst in publiek toegankelijke documentatie (voor gebruikers en integrators) en beveiligde interne documentatie (voor het engineering- en operations-team).
🌐 Publieke Documentatie
1. Gebruikershandleidingen (User Flows)
Praktische handleidingen voor adviseurs, makelaars en kantoormedewerkers:
- Gebruikersaccount: Profiel, beveiliging (2FA/MFA), e-mailinstellingen en acties.
- Organisatieaccount: Kantoorinstellingen, branding, facturatie, automatische herinneringen, klantvelden en integraties.
- Vragenlijsten maken: Intake-formulieren bouwen, vraagtypes, logica, PDF-rapporten en communicatiesjablonen.
- Contacten & Contactgroepen: Klantenfiches, portefeuilles, bulkselecties, import/export en communicatiehistoriek.
- Acties & Sessies: Formulieren en documenten versturen, batchverwerking, statussen en antwoorden analyseren in sessiedetails.
2. Technische Integraties & API Tester
Voor externe IT-partners, softwareleveranciers en ontwikkelaars:
- Authenticatie & API Keys: API-sleutels (
x-api-key), server-naar-server koppelingen, rechten en codevoorbeelden. - Webhooks & Event-notificaties: Real-time statusupdates, HMAC-SHA256 handtekeningverificatie en payload-schema's.
- REST API Referentie: Overzicht van endpoints voor klanten, vragenlijsten, acties en sessies.
- OAuth 2.0 & Single Sign-On: API clients, Google Workspace en Microsoft 365 integraties.
- Eigen Domeinnaam & DNS Setup: CNAME/A-records, Let's Encrypt SSL en kantoordomeinen koppelen.
- Model Context Protocol (MCP) Server: AI-agents koppelen (Claude Desktop, Cursor, Antigravity) via streaming SSE.
- ActionSetup & QuickSigningSetup: Pre-fill APIs en 1-klik deep-linking vanuit externe CRM-software.
- BrokerCloud CRM Integratie: Tweewegsynchronisatie, klantimport en automatische dossier-push.
- Live API Tester & Playground: Interactieve REST API console om live requests direct te testen in de browser.
🔒 Interne Technische Documentatie (Beveiligd)
Wachtwoord vereist
Onderstaande interne documentatie is afgeschermd met authenticatie voor het interne Sidefish engineering team.
- Systeemarchitectuur & Hosting: VM-specificaties, Docker Compose stack, Traefik routing en opslagvolumes.
- Deployment & CI/CD Pipeline: GitLab CI pipeline, geautomatiseerde image builds, Cosign verificatie en SSH releases.
- Databasebeheer & Backups: MongoDB 8.0 datamodellen, Typegoose schemas, dagelijkse dumps en herstelprocedures.
- Monitoring, Logs & Alerting: Grafana Alloy, Loki logaggregatie, Bugsink Sentry tracking en Prometheus metrieken.
- Background Workers & Schedulers: Redis Bull queues, verjaardagsschedulers, overdue checks en batch analytics.
- Model Context Protocol (MCP) Server: Interne streaming SSE transport, AI-agent integraties en tool capabilities.