Integration
API-Token
Verwalten Sie API-Tokens für die Integration externer Systeme
Die API-Token-Verwaltung ermöglichen eine sichere und automatisierte Integration externer Systeme, indem sie den Zugriff auf die Funktionen des Output-Management-Systems authentifizieren und autorisieren.
Der eigentliche Token-Wert wird automatisch beim Speichern eines neuen Token-Elements generiert und ausschließlich in der Detailansicht angezeigt. Die sensible Token-Zeichenfolge selbst wird nicht eingegeben, sondern nur in der Detailansicht angezeigt.
Erstellen Sie hier API-Tokens, deren Wert sie danach in ihren Systemen verwenden können.
Diese Seite zeigt eine Liste aller Elemente, und darüber diverse Aktionen, die du ausführen kannst:
API-Token-Liste
ID, Identifier, Aktiv ab, Aktiv, Beschreibung
| ID | Identifier | Gruppen-Identifier | Aktiv ab | Aktiv | Beschreibung |
|---|---|---|---|---|---|
| identifier_name | Null | Aktiv |
ID
Eindeutige Nummer zur internen Identifikation des API-Tokens.
Identifier
Eindeutiger Name des API-Tokens für Rendering und API-Aufrufe.
Eindeutiger Name für eine optionale Gruppierung von verwandten API-Tokenn. Elemente einer Gruppe werden gemeinsam verarbeitet und optionale Validatoren können dabei einzelne Elemente aktivieren oder ignorieren.
Aktiv ab
Startdatum eines API-Tokens. API-Tokens werden erst ab diesem Datum beim Rendern beachtet.
Aktiv
Schnellübersicht, ob das API-Token derzeit freigegeben ist. Deaktivierte Elemente behalten ihre Historie, werden aber nicht mehr automatisch verwendet.
Beschreibung
Beschreibung zur schnellen Einordnung im Backend. Unterstützt frei formulierte, redaktionelle Hinweise zur Funktion oder zum Einsatzzweck des/r API-Tokens.
Verwenden Sie sprechende Identifier wie retool-backoffice-ui oder sns-reporting-gateway, damit klar bleibt, welches System auf das Token zugreift. „Aktiv ab“ eignet sich, um Tokens bereits vor Produktivstart anzulegen und erst später freizuschalten.
Mandant
Nutzen Sie die Mandanten-Spalte, um API-Tokens klar einer Umgebung oder Submarke zuzuordnen. So bleiben Berechtigungen und Abrechnungen bei mehreren Tochterunternehmen nachvollziehbar.
| Umgebungs-Mandant | Standard für Umgebungs-Mandanten | Benutzerdefinierte ID | Farbe |
|---|---|---|---|
| (1880) Submarke 1 | NO | Null | |
| Null | YES | <<payload.value>> |
Zugeordneter Mandant des/der API-Token. Ermöglicht Mandanten-spezifische Konfiguration.
Kennzeichnet API-Token als Standard und vererbt (verfügbar) für alle Umgebungs-Mandanten.
Optionale benutzerdefinierte Kennung nach dem Rendering für externe Systeme. Wird als Referenzen des/der API-Token bei Callbacks übergeben und beherrscht Vorlagen-Syntax inkl. Zugriff auf Payload-Daten.
Visuelle Kennzeichnung für schnelle Identifikation des/der API-Token. Vor allem nützlich für Dashboard-Statistiken und Charts.
Erstellt am, Aktualisiert am
| Validatoren | Pausiert | Erstellt am | Aktualisiert am |
|---|---|---|---|
| Null | NO | ||
| missing_street | YES |
Zugewiesene Validierungsregeln für das API-Token. Prüfen Ihre Bedingungen vor der Verarbeitung und aktivieren/deaktivieren das Rendering entsprechend.
Temporäre Deaktivierung des API-Tokens. Pausierte Elemente werden nicht verarbeitet.
Erstellt am
Zeitstempel der API-Token-Erstellung.
Aktualisiert am
Zeitstempel der letzten Änderung. Zeigt wann API-Token-Konfiguration zuletzt bearbeitet wurde.
Kontext-Aktionen
Aktions-Dropdown
Aktions-Dropdown
Klicken Sie auf das Drei-Punkte-Menü am Ende jeder Zeile für Aktionen mit dem jeweiligen API-Token.
Testen
Öffnet eine API-Token-Testumgebung zum lokalen Rendern mit bearbeitbaren Validatoren und JSON-Testdaten.
API-Token herunterladen
Lädt die Quell-Datei des API-Token auf Ihren Computer herunter.
Anzeigen
Öffnet eine reine Detailansicht der kompletten Meta-Informationen und Einstellungen des API-Token.
Ändern
Öffnet das Bearbeitungsformular für alle Einstellungen und den Upload einer neuen API-Token-Version.
Löschen
Entfernt das API-Token dauerhaft aus dem System. Diese Aktion kann nicht rückgängig gemacht werden.
Sichtbarkeit: Aktionen wie „Token regenerieren“ oder „Löschen“ sind nur in der Detailansicht verfügbar, um versehentliche Änderungen an produktiven Integrationen zu vermeiden.
Filter
- Filtern öffnet das Modal mit vordefinierten Kriterien wie Aktiv-Status, Datumsintervallen für „Aktiv ab“ oder Stichwörtern im Identifier.
- Zurücksetzen entfernt gesetzte Filter und zeigt wieder alle Tokens.
- Anwenden aktiviert die ausgewählten Filter und aktualisiert die Tabelle sofort.
Spalten konfigurieren
Passen Sie die Anzeige der API-Token-Liste für bessere Übersichtlichkeit an. Spalten können per Drag-and-Drop neu angeordnet und über Checkboxen ein-/ausgeblendet werden.
Für mich anwenden : Spalten-Konfiguration wird nur für Ihren Account gespeichert und beeinflusst andere Benutzer nicht.
Als Standard anwenden : Konfiguration wird für alle Benutzer der Instanz übernommen und als neue Standard-Ansicht gesetzt.
Die Spaltenkonfiguration wirkt benutzerbezogen: „Für mich anwenden“ speichert die Auswahl lokal, „Als Standard anwenden“ setzt die Ansicht für alle Teammitglieder, die denselben Mandanten verwalten.
API-Token erstellen
Aktions-Buttons zum Speichern und Verwalten der API-Token-Konfiguration.
Verwenden Sie "Erstellen und weiteres Element hinzufügen" für effizientes Batch-Erstellen mehrerer Elemente.
Der eigentliche Token-Wert wird nach dem Speichern vom System generiert und dann in der Detailansicht angezeigt. Das Formular erfasst ausschließlich Metadaten wie Identifier, Beschreibung, Aktivierungszeitpunkt und den optionalen Mandantenbezug.
Formularfelder
Identifier
Eindeutige Kennung für dieses/r API-Token zur programmatischen Verwendung, Einbindung in Vorlagen, Lookups und API-Zugriff.
Identifiers sollten 'snake_case' sein, also klein geschrieben und Unterstriche verwenden, z.B. 'kunde_name' oder 'rechnung_nummer'.
Aktiv ab und Aktiv
Startdatum des API-Tokens. API-Tokene werden erst ab diesem Datum beim Rendern beachtet.
Die Aktiv-Checkbox ermöglicht eine sofortige De-/Aktivierung unabhängig vom Datum.
Vor-Terminierung: Mit diesem Feld können API-Tokene vor-terminiert werden. Setzen Sie ein zukünftiges Datum, um das Element automatisch ab diesem Zeitpunkt zu aktivieren.
Mehrere Elemente mit gleichem Identifier: unterschiedliches 'Aktiv ab' staffelt die Version; bei einer Anfrage gilt das aktive Element mit dem spätesten Aktiv ab (nicht Erstell- oder Änderungsdatum).
Beschreibung
Interne Beschreibung eines/r API-Token für Identifikation und bessere Übersicht bzw. Dokumentation. Diese Beschreibung wird im Output.Rocks-Backend verwendet und nicht im Output angezeigt.
Beschreibungen sollten kurz und prägnant sein, um Übersichtlichkeit zu gewährleisten. Längere Erklärungen sollten im Feld 'Kommentar' platziert werden.
Mandant
Zuordnung zu einem spezifischen Umgebungs-Mandanten oder Standard-Verwendung für alle Mandanten.
Verwandte Backend-Bereiche
- Zugangsdaten: Hinterlegen Sie weitere Authentifizierungs-Informationen für externe Systeme und binden Sie sie an Token-gestützte Prozesse.
- E-Mail-Server: Verwalten Sie SMTP-Konfigurationen, die nach erfolgreicher Token-Authentifizierung Trigger für automatisierte Zustellungen verwenden.
- Webhooks: Definieren Sie Antwort-Endpunkte, die nach authentifizierten Requests mit API-Token aufgerufen werden.
Relevante Use Cases
- API-Integration mit Output.Rocks: Vollständige Einführung in die API-Nutzung, Authentifizierung und Powercloud-Integration.
- Benutzerdefinierte Zugangsdaten: Zeigt, wie Token-basierte Konfigurationen mit E-Mail- und Dokumenten-Prozessen zusammenspielen.
- Mandanten-Management: Erklärt, wie API-Tokens Mandanten-bezogen verwaltet und vererbt werden.
API-Referenzen & Funktionen
- API Endpoint: POST /renderings: Dokumentiert den Standard-API-Aufruf, der mit API-Tokens authentifiziert wird.
- API Reference: Enthält die vollständige Referenz aller verfügbaren Endpunkte, Modelle und Request-/Response-Schemata.