REST-API · OpenAPI-Schema

Bauen Sie auf PrivateCore auf

Eine REST-API und ein Grundsatz: Sie läuft auf Ihrer Instanz, nie auf einem Server, den Sie mit anderen Kunden teilen. Online ist das der für Sie gemietete Server, mit dem Mac mini das Gerät an Ihrer Theke. Die Schlüssel gehören Ihnen, und Sie widerrufen sie mit einem Klick.

Was die API ermöglicht

  • Ihre eigenen Werkzeuge anbinden: eine Airtable-Tabelle, ein Slack, ein Alt-ERP, ein selbst gebautes Grafana-Dashboard.
  • Wiederkehrendes automatisieren: die wiederkehrenden Rechnungen des Monats erzeugen, eine Erinnerung auslösen, wenn ein Angebot 7 Tage unsigniert bleibt, den Bestand mit einem Lieferanten abgleichen.
  • Interne Anwendungen bauen: eine mobile App für das Serviceteam, ein Buchungs-Widget auf Ihrer Präsentationsseite, ein individuelles Standort-Dashboard für die Geschäftsführung.
  • Prüfen und exportieren: Ihre gesamte Buchhaltung als JSON abholen, die französische FEC-Buchungsdatei auf Abruf erzeugen, Ihre Datenbank in Ihr eigenes Data Warehouse spiegeln.

Zwei Aufrufbeispiele

TypeScript

fetch
TypeScript 
const base = 'https://votre-instance';
const headers = { Authorization: `Bearer ${process.env.PRIVATECORE_API_KEY}` };

// Kunden auflisten (Schlüssel mit Berechtigung read:crm)
const { items, next_cursor } = await fetch(`${base}/api/public/v1/clients?limit=50`, { headers })
  .then((r) => r.json());

Python

requests
Python 
import os
import requests

base = "https://votre-instance"
headers = {"Authorization": f"Bearer {os.environ['PRIVATECORE_TOKEN']}"}

# Die FEC-Buchungsdatei des laufenden Geschäftsjahres exportieren
fec = requests.get(f"{base}/api/fec/export", params={"year": 2026}, headers=headers)
open("fec_2026.txt", "wb").write(fec.content)

Authentifizierung

API-Schlüssel mit begrenzter Reichweite, widerrufbar, auf Wunsch mit Ablaufdatum.

  • Erstellung: ein Schlüssel pro Integration, im Entwicklerbereich Ihrer Instanz. Sie wählen seine Berechtigungen (Kunden lesen, Buchungen lesen usw.).
  • Danach nie mehr lesbar: Der Schlüssel wird nur einmal angezeigt, bei der Erstellung. Ihre Instanz speichert nur einen SHA-256-Fingerabdruck. Geht er verloren, widerrufen Sie ihn und erstellen einen neuen.
  • Nachverfolgung: Jeder Schlüssel speichert das Datum seiner letzten Nutzung, damit Sie ungenutzte erkennen.
  • Sofortiger Widerruf: Ein Klick genügt. Das Token wird augenblicklich ungültig.

Nutzungsgrenzen

Kein abgerechnetes Kontingent. Jeder Schlüssel ist auf 60 Anfragen pro Minute begrenzt (auf der Instanz einstellbar), damit ein außer Kontrolle geratenes Skript die Oberfläche der anderen Nutzer nicht bremst.

Darüber antwortet die API mit 429 und einem Retry-After-Header: Das Skript wartet eine Minute und macht weiter.

Dokumentation und Status

  • Vollständige Dokumentation: /docs auf Ihrer Instanz (aus dem Code erzeugte OpenAPI-Referenz).
  • Änderungsprotokoll: Jede Backend-Version stellt einen Endpunkt /api/v1/changelog bereit.
  • OpenAPI: OpenAPI 3.1-Spezifikation offen verfügbar unter /api/openapi.json. Kompatibel mit Postman, Insomnia und Codegeneratoren Dritter.
  • Status: Die API stellt Gesundheitsprüfungen bereit (/health, /health/ready), die ein Überwachungswerkzeug abfragen kann.
API-Zugang anfragen

Bereit, die Kontrolle zurückzunehmen?

Eine Einrichtung nach Maß, eine Antwort vom Gründer und ein Mac Mini, den Sie selbst kaufen oder den wir eingerichtet liefern.

Bestellen Mit einem Gründer sprechen