Anwendungen und Schlüssel
Eine Echo-Anwendung steht für einen Verbraucher oder Anbieter in deinem Arbeitsbereich. Sie ist keine Person, die sich bei Maestro anmeldet. Ihre eck_-Schlüssel erlauben Automatisierungen den Zugriff auf bestimmte Echo-APIs, ohne die Sitzung eines Benutzers zu verwenden.
Registriere die Anwendung
Öffne Anwendungen in Maestro, erstelle die Anwendung und füge Vertragsbindungen hinzu. Wähle Consumes für eine aufgerufene Operation oder Provides für eine angebotene Operation und lege die vereinbarte Version fest. Anwendungen erstellen und ändern, Vertragsbindungen verwalten sowie Schlüssel ausstellen gehören zu den bezahlten Echo-Tarifen Pro und Pro AI und erfordern die Berechtigung Echo/ManageHosting in der Gruppe MockServers. In einem bezahlten Tarif erhält der Organisationsadministrator diese Berechtigung standardmäßig und kann sie einer anderen Rolle zuweisen. In Free erscheint der Bereich nicht im Menü. Über den direkten Link kannst du vorhandene Anwendungen und Schlüssel trotzdem einsehen und einen offengelegten Schlüssel widerrufen.
Vergib die erforderlichen Berechtigungen
| Scope | Erlaubt | Erlaubt nicht |
|---|---|---|
ReadBoundContracts |
Konsumierte Verträge dieser Anwendung und ihre Kompatibilitätsänderungen lesen | Versionen veröffentlichen oder alle Verträge des Arbeitsbereichs lesen |
PublishOwnedContracts |
Versionen bestehender Verträge mit einer Provides-Bindung dieser Anwendung veröffentlichen |
Verträge erstellen, Eigentum übernehmen oder Verträge anderer Anwendungen veröffentlichen |
ServeMocks |
Regeln aktiver Mocks laden, die über Teams im Arbeitsbereich geteilt werden | Persönliche Mocks laden, Hosting verwalten oder Vertragsveröffentlichungen erlauben |
ServeMocks ist nicht auf die Vertragsbindungen dieser Anwendung begrenzt. Es liest gemeinsame Mock-Regeln im Arbeitsbereich. Die Mocks müssen dafür nicht im öffentlichen Dienst veröffentlicht sein, aber der Regelfeed gehört wie das öffentliche Hosting zu Echo Pro und Pro AI. Ohne ein gültiges bezahltes Echo-Abonnement wird der Abruf der Regeln mit 403 abgewiesen. Ein vorhandener Schlüssel mit ReadBoundContracts kann weiterhin die ihm zugeordneten Verträge lesen. Verwende getrennte Schlüssel für die CI des Verbrauchers und die Veröffentlichung des Anbieters.
Erstelle und verwahre einen Schlüssel
- Öffne die Schlüssel der Anwendung, erstelle einen Schlüssel und wähle nur die benötigten Scopes.
- Beschreibe seinen Zweck und wähle ein Ablaufdatum.
- Kopiere sofort das vollständige Geheimnis. Es wird nur einmal angezeigt. Spätere Listen zeigen das Präfix und die Metadaten.
- Speichere es in den CI-Secrets, in der Umgebung oder in einem Tresor. Es gehört nie in Commits, Browsercode, Screenshots oder URLs.
Die Paketbeispiele verwenden Umgebungsvariablen. Die Pakete senden den Schlüssel an die API, nicht an die öffentliche Mock-URL. Die öffentliche Kennung eines im öffentlichen Dienst veröffentlichten Mocks ist ein eigener Zugriffsmechanismus.
Erneuere und widerrufe
Zum Erneuern erstellst du in Echo Pro oder Pro AI einen Ersatz, aktualisierst den aufrufenden Prozess, prüfst ihn und widerrufst den alten Schlüssel. Einen verlorenen oder offengelegten Schlüssel kannst du auch nach Ablauf des bezahlten Tarifs widerrufen: Öffne Anwendungen in Maestro direkt, wähle die Anwendung und widerrufe ihn in ihrer Schlüsselliste. Das Menü zeigt den Bereich ohne bezahlten Tarif nicht an, der direkte Link und der Widerruf bleiben aber verfügbar. Für einen neuen Schlüssel brauchst du wieder einen bezahlten Tarif und die Berechtigung Echo/ManageHosting.
Ein Widerruf verhindert zukünftige authentifizierte API-Zugriffe. Er löscht keine Regeln, die Mock.Client oder Mock.Server bereits zwischengespeichert haben. Fehlgeschlagene Aktualisierungen behalten die letzte Momentaufnahme. Soll dieser Prozess sofort aufhören zu mocken, deaktiviere die Interception oder stoppe ihn und behandle seinen Cache ausdrücklich.
Zum Deaktivieren einer öffentlichen Mock-URL oder zum Erneuern ihrer Kennung nutzt du den Bereich "Öffentliches Hosting" aus dem Leitfaden Öffentliches Mock-Hosting. Der Widerruf eines eck_-Schlüssels deaktiviert diese URL nicht.