Das Herzstück von Paloma ist eine REST-API: Jede Information, die Ihre Verwaltung im Browser sieht, lässt sich auch maschinell abfragen – und jede Aktion auch maschinell auslösen. Damit verbinden Sie Paloma mit Ihrer Buchhaltung, Ihrer Website oder Ihren eigenen Auswertungen.
# 1 – Token holen
POST /api/authenticate
{ "username": "…", "password": "…" }
# 2 – Mit dem Token arbeiten
GET /api/members/4711
Authorization: Bearer <token>
# Antwort
{
"id": 4711,
"memberNumber": "10 023 415",
"lastName": "Meyer",
"firstName": "Anneliese"
}Paloma ist von Anfang an als Server mit einer REST-API gebaut – die Weboberfläche Ihrer Verwaltung ist selbst nur ein Client dieser API. Es gibt also keine „Datenexport-Schnittstelle“ neben dem System: Sie arbeiten auf denselben Ressourcen wie die Anwendung.
Stammdaten, Adressen, Bankverbindungen, Verträge mit Tarif, Versicherungssumme und Bezugsberechtigten – lesen, anlegen und ändern. Jede Änderung über die API landet in derselben Historie wie eine Änderung aus der Oberfläche.
Sollstellungen, Lastschriften, Buchungen auf Mitglieds- und Sachkonten, offene Posten und Mahnstufen. Die Grundlage, um Paloma mit Ihrer Finanzbuchhaltung oder Ihrem Zahlungsverkehr zu verbinden.
Dokumente zu einem Mitglied ablegen, abrufen und aus Vorlagen erzeugen. Damit lassen sich Posteingänge aus Ihrem Scan- oder DMS-Prozess automatisch am richtigen Vorgang einhängen.
Neuantrag, Sterbefall, Kündigung oder Stammdatenänderung lassen sich auch von außen anstoßen – mit denselben Prüfungen und Berechnungen, die Paloma auch in der Oberfläche anwendet.
Bestandszahlen, Alters- und Summenverteilungen, Beitragsaufkommen. Wer eigene Berichte in Excel, Power BI oder einem Data-Warehouse fährt, holt sich die Zahlen direkt aus Paloma – statt sie abzutippen.
Benutzerkonten, Rollen und Berechtigungen sind ebenfalls Ressourcen der API. Ein technischer Zugang bekommt dadurch genau die Rechte, die er braucht – und keine mehr.
Ressourcenorientierte Pfade, JSON in beide Richtungen, HTTP-Statuscodes mit der üblichen Bedeutung. Alles unter dem Basispfad /api Ihrer Installation.
Ein Ausschnitt zur Veranschaulichung. Maßgeblich ist die OpenAPI-Beschreibung Ihrer Version.
Ein technischer Zugang ist in Paloma ein Benutzerkonto wie jedes andere – mit Rollen, Rechten und vollständiger Protokollierung. Was ein Integrationsdienst tun darf, entscheiden Sie, nicht wir.
Gegen /api/authenticate mit Benutzername und Kennwort – oder über Ihr Verzeichnis: Paloma unterstützt LDAP und OAuth 2, sodass ein technischer Zugang in Ihrer bestehenden Benutzerverwaltung geführt werden kann.
Sie erhalten ein JWT, das jedem Aufruf als Authorization: Bearer … mitgegeben wird. Läuft es ab, holt ein Refresh-Aufruf ein neues – ohne die Zugangsdaten erneut zu senden.
JWT · BearerÜber Rollen und Berechtigungen legen Sie fest, welche Daten der Zugang sieht und welche Aktionen er auslösen darf – bei mehreren Kassen in einer Installation auch, auf welche davon.
Transport: Die API wird ausschließlich über TLS betrieben. Ob die Schnittstelle überhaupt aus Ihrem Netz heraus erreichbar ist, bestimmen Sie – bei einer On-Premise-Installation liegt das vollständig in Ihrer Hand. Für den Zugriff von außen empfehlen wir eine Einschränkung auf bekannte Adressbereiche.
Die meisten Integrationen beginnen mit einem einzigen Satz: „Diese Zahlen tippen wir jeden Monat ab.“ Genau dort lohnt sich die Schnittstelle – und häufig ist die Lösung anschließend so allgemein nützlich, dass sie ohne Zusatzkosten in den Standard wandert.
Paloma steht ausschließlich auf etablierten Open-Source-Technologien. Es gibt keine proprietären Datenformate – und damit kein Lock-in. Ihre Daten bleiben in einer Datenbank, die jeder Entwickler lesen kann.
Auf den Arbeitsplätzen ist nichts zu installieren und nichts zu pflegen: Paloma läuft vollständig im Browser, unabhängig von einer bestimmten Windows- oder Office-Version. Für Ihre IT bedeutet das kein Rollout, keine Client-Updates und keine Terminalserver-Sonderlocke – nur einen Server und ein Zertifikat.
Die Schnittstellenbeschreibung ist nicht öffentlich, aber auch nicht schwer zu bekommen: Ein Satz per E-Mail genügt. Wir stellen sie im standardisierten OpenAPI-Format bereit – daraus erzeugen die üblichen Werkzeuge Ihnen direkt einen Client.
Schreiben Sie uns kurz, was Sie vorhaben und welches System Sie anbinden möchten. Ihre Anfrage landet bei den Entwicklern, nicht in einem Ticketsystem ohne Antwort.
Sie bekommen die OpenAPI-Beschreibung Ihrer Version sowie die Hinweise zur Authentifizierung – und, falls nötig, eine kurze Einordnung, welche Ressourcen für Ihren Fall die richtigen sind.
OpenAPIFür die Entwicklung stellen wir eine Testumgebung mit Testdaten bereit. So arbeitet niemand gegen den Produktivbestand, solange die Integration noch entsteht.
TestdatenTechnischer Zugang mit passenden Rechten, Freischaltung im Netz, fertig. Bei Rückfragen während der Umsetzung sprechen Sie direkt mit den Entwicklern von Paloma.
Wenn eine Anforderung aus Ihrem Haus für andere Kassen ebenso sinnvoll ist, übernehmen wir sie häufig ohne Zusatzkosten in den Standard – dann pflegen und aktualisieren wir sie dauerhaft mit. Das ist für beide Seiten die bessere Lösung als eine Sonderentwicklung, die bei jedem Update Aufmerksamkeit braucht.
Sprechen Sie deshalb auch dann mit uns, wenn Sie eine Integration selbst bauen könnten: Vielleicht steht sie schon auf unserer Liste.
Nein. Die REST-API ist Teil von Paloma und in der Jahresgebühr enthalten – es gibt kein Schnittstellenmodul, das gesondert lizenziert wird, und keine Abrechnung nach Aufrufen. Zusätzlicher Aufwand entsteht nur, wenn wir eine Integration für Sie entwickeln sollen.
Weil sie zur konkreten Version Ihrer Installation gehört. Eine öffentlich abgelegte Datei wäre nach wenigen Wochen veraltet und würde mehr Verwirrung stiften als helfen. Sie erhalten die Beschreibung, die zu Ihrem Stand passt – auf eine kurze E-Mail hin, ohne Vertragswerk und ohne Wartezeit.
Wir entwickeln Paloma laufend weiter, halten bestehende Felder und Pfade dabei aber bewusst stabil. Wo eine Änderung unvermeidlich ist, informieren wir die betroffenen Häuser vorab – und weil wir wissen, wer welche Integration betreibt, ist das ein Anruf und keine Suchaktion.
Der etablierte Weg ist heute die zyklische Abfrage: Ein Dienst fragt in einem festen Takt, was sich geändert hat. Wenn Ihr Szenario eine ereignisgesteuerte Benachrichtigung braucht, sprechen Sie uns an – wir schauen uns den Fall an und sagen Ihnen offen, was heute geht und was wir dafür bauen müssten.
Lesend im eigenen Betrieb: technisch möglich, da es keine verschlossenen Formate gibt. Schreibend raten wir davon ab. Die API führt alle fachlichen Prüfungen, Berechnungen und die revisionssichere Historisierung aus – wer daran vorbei schreibt, umgeht genau das, was Ihren Bestand konsistent hält.
Jede Änderung über die API wird wie jede andere Änderung protokolliert: Sie sehen in der Historie, welcher Zugang wann was geändert hat. Für die Fachlogik Ihrer eigenen Integration sind Sie verantwortlich – deshalb die Testumgebung und deshalb ein Zugang mit möglichst engen Rechten.
Ja. Ein großer Teil unserer Kunden hat keine eigene Entwicklungsabteilung. In diesen Fällen setzen wir die Integration um oder arbeiten mit dem IT-Dienstleister Ihres Hauses zusammen. Häufig lässt sich das Anliegen ohnehin ohne eigene Programmierung in Paloma abbilden – fragen Sie einfach.
Ob Schnittstellenbeschreibung, Zugang zur Testumgebung oder die Frage, ob Ihr Vorhaben überhaupt Programmierung braucht: Schreiben Sie kurz, was Sie erreichen wollen. Sie bekommen eine technische Antwort von einem Entwickler – keine Broschüre.
