Auf einen Blick
Für wen das gedacht ist
Teams mit einer funktionierenden API und ohne Benutzerverwaltung davor
Datenanbieter, die Zugriff verkaufen und kein Abrechnungssystem bauen wollen
Unternehmen, deren interne API nun zahlende Kunden bedienen soll
KI- und Dokumentdienste, die Tokens, Seiten oder Rechenzeit abrechnen
Was Sie sonst selbst bauen müssten
Ihre API funktioniert. Es fehlt alles drumherum. Sie haben Endpunkte. Ihnen fehlen Konten, Rollen, Pläne, Kontingente, Verbrauchsmessung, Rechnungen mit USt., Zahlungseinzug und eine Preisseite, und Ihre Kunden erwarten all das, bevor sie zahlen. Jedes Teil muss außerdem gepflegt werden, solange es das Produkt gibt.
Was Sie bekommen
Zugriffskontrolle auf jeder Route
Hinterlegen Sie im Relay Ihre Upstream-Basis-URL und ein OpenAPI-Dokument (3.0, 3.1 oder Swagger 2.0). Ein geschütztes Dokument lädt UniCore mit den Upstream-Zugangsdaten. Jeder Pfad erhält dann vier benannte Berechtigungen: Lesen, Anlegen, Ändern und Löschen. Sie vergeben sie an einen Benutzer, eine Organisationseinheit oder eine Rolle, oder überlassen das dem Abonnement. Der Kauf eines Plans vergibt dessen Rollen, und wenn das Abonnement endet oder ausgesetzt wird, werden sie wieder entzogen. Ein Kunde darf so einen Pfad lesen, ohne dort schreiben zu dürfen. Der Zugriff wird entschieden, bevor die Anfrage bei Ihnen ankommt.
Pläne, Verbrauchsmessung und Abrechnung
Verknüpfen Sie das Relay mit einem Produkt und legen Sie Pläne an. Das API-Gateway zählt Aufrufe, Datenvolumen, Credits oder Tokens und setzt die Limits der Pläne durch: Über einem Limit lehnt es Aufrufe ab, bevor Ihre API sie sieht, oder Sie rechnen Mehrverbrauch bis zu einem Kostendeckel ab. Rechnungen mit USt., E-Rechnungen und Zahlung über Stripe gehören dazu.
Ihr eigenes Routenpräfix
Routen erscheinen unter /eps/{ihr-präfix}/…: ein Endpunkt je OpenAPI-Pfad und Zugriffsstufe, kein Sammel-Proxy. Das Präfix ist ein Pfadsegment mit bis zu 100 Zeichen (Buchstaben a bis z ohne Umlaute, Ziffern, Punkt, Unterstrich, Tilde oder Bindestrich) und im gesamten System eindeutig, unabhängig von der Groß- und Kleinschreibung, sodass kein anderer Mandant denselben öffentlichen Pfad belegen kann. Ein Pfad, den Ihre Spezifikation nicht aufführt oder der sich nicht sicher routen lässt, antwortet mit 404. Deshalb gelten Berechtigungen, Limits und Verbrauchsmessung je Route, Operation oder Relay.
Upstream-Zugangsdaten bleiben bei Ihnen
UniCore fügt die Upstream-Zugangsdaten beim Weiterleiten ein: als API-Schlüssel, Bearer-Token, Basic-Authentifizierung oder eigenen Header. Sie tauschen sie im laufenden Betrieb aus, ohne das Relay oder seine Berechtigungen anzufassen. Die Zugangsdaten werden verschlüsselt gespeichert, von der API nie zurückgegeben und nie an einen Aufrufer weitergegeben.
Eine öffentliche Swagger-Seite je Relay
Schalten Sie die öffentliche Swagger-Seite eines Relays ein: Sie zeigt nur die Operationen, die Sie bereitstellen, bindet die Bearer-Anmeldung von UniCore ein und kennzeichnet Operationen mit Verbrauchsmessung. Upstream-Adressen und Herstellererweiterungen werden entfernt.
Routen, die Ihre Spezifikation nicht aufführt
Ergänzen Sie manuelle Endpunkte für die Teile Ihrer API, die Ihr OpenAPI-Dokument nicht abdeckt. Jeder kann an einen anderen Upstream-Pfad weiterleiten und eigene Upstream-Zugangsdaten nutzen. Aufrufer werden wie auf jeder anderen Route geprüft.
Abrechnen, was Ihre API meldet
Legen Sie im Relay fest, wo Tokens, Seiten oder Rechenzeit stehen: in einem Antwort-Header, einem JSON-Feld oder einem Stream-Ereignis. UniCore bucht sie je Aufruf auf das Guthaben des Kunden, auch bei gestreamten Antworten.
Was UniCore mitbringt und was Sie schreiben
Alles links gehört zu UniCore und wird von uns gepflegt. Alles rechts schreiben Sie selbst.
Das liefert UniCore
Konten, Sitzungen und Sitzungserneuerung, mit Anmeldung per E-Mail und Passwort
Anmeldung mit Google, Microsoft oder Ihrem eigenen OIDC-Anbieter (Paket Platform)
Rollen, Organisationseinheiten und benannte Berechtigungen, bis zum einzelnen Datensatz, dazu Zugriffskontrolle je Route
Mandanten und Mandantentrennung
Produkte und Pläne mit Grundpreis, Testphase und Laufzeit, dazu Zusatzpakete zum Nachkaufen
Verbrauchsmessung je Kunde und Kontingente für Aufrufe, Datenvolumen, Credits und Tokens, dazu Rate-Limits und Abrechnung von Mehrverbrauch mit Kostendeckel
IP-Freigabelisten, Audit von Änderungen und Lesezugriffen (Paket Platform) und eine Anfrage-ID für jeden weitergeleiteten Aufruf
Einfügen und Rotation von Upstream-Zugangsdaten sowie ein Verbindungstest, bevor Sie ein Relay speichern
Eine optionale öffentliche Swagger-Seite je Relay
Gestreamte Antworten und WebSockets auf Wunsch, mit optionalen Wiederholungen und einem Circuit Breaker
Ein Betreiber-Dashboard auf Deutsch und Englisch
Rechnungen mit USt. aus dem nächtlichen Abrechnungslauf, E-Rechnungen (ZUGFeRD, Factur-X, XRechnung), Gutschriften, Kartenzahlung über Ihr Stripe-Konto oder eine Überweisung, die Sie erfassen, und Mahnwesen bei fehlgeschlagenen Zahlungen
Shop-Bausteine in React für Preisseite, Kasse, Verbrauch und Rechnungen, gespeist aus dem Live-Katalog über einen typisierten API-Client
API-Schlüssel, die Ihre Kunden selbst anlegen
Buchung des Verbrauchs, den Ihre API meldet
Das schreiben Sie
Ihre API
Ihre Website, mit den React-Shop-Bausteinen für Preisseite, Kasse und Rechnungen
Ihre Preise, Ihre Verkäufer- und Steuerangaben und Rechtstexte, die Ihre Rechtsberatung freigegeben hat
Häufige Fragen
Ihre Frage ist nicht dabei? Schreiben Sie uns kurz, worum es geht.
Ihre API bleibt, wie sie ist. Das Relay sitzt davor und leitet an Ihre Upstream-Basis-URL weiter. Zugang, Pläne, Limits und die Zählung von Aufrufen und Bytes funktionieren mit der API in ihrem heutigen Zustand. Um Tokens, Seiten oder Rechenzeit abzurechnen, liest das Relay sie aus einem JSON-Feld oder Stream-Ereignis, das Ihre API schon liefert, oder aus einem Antwort-Header, den Sie ergänzen.
Dafür gibt es drei Modi. Sie arbeiten nur mit der Spezifikation, mit Spezifikation plus manuellen Endpunkten (Standard) oder nur mit manuellen Endpunkten, ganz ohne Spezifikation. So kommen Sie auch mit einer lückenhaften Spezifikation ans Ziel.
Das Paket Relay. Es enthält Relays, Pläne, Verbrauchsmessung, Rechnungen, Zahlung, Jobs und Webhooks. Kunden melden sich mit Passwort oder API-Schlüssel an. Build ergänzt eigene Datenmodelle und Pipelines. Platform ergänzt die Anmeldung über Google, Microsoft oder Ihren eigenen OIDC-Anbieter, Nachrichtenkanäle, Zeitreihen und Auditierung.
Kontingente gelten für Benutzer, die die Route über einen abonnierten Plan erreichen. Wer sie über eine direkt erteilte Berechtigung oder eine Standardrolle aufruft, bleibt frei von Kontingent und Mehrverbrauch. Für diese Aufrufer gelten die Rate-Limits, die Sie am Relay oder Endpunkt setzen. Über den Zugriff entscheiden Rollen und Berechtigungen, Kontingente regeln den Verbrauch.
Lassen Sie sich UniCore an Ihrem eigenen Anwendungsfall zeigen
Dreißig Minuten per Bildschirmfreigabe: ein Relay, ein Plan, ein gemessener Aufruf und eine Rechnung, danach Ihre API oder Ihre Produktidee. Keine Folien.