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. Zum Verwalten von Anwendungen und Schlüsseln brauchst du Administratorrechte im Arbeitsbereich.
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. Öffentliches Hosting dieser Mocks ist dafür nicht erforderlich. 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 gehosteten Mocks ist ein eigener Zugriffsmechanismus.
Erneuere und widerrufe
Zum Erneuern erstellst du einen Ersatz, aktualisierst den aufrufenden Prozess, prüfst ihn und widerrufst den alten Schlüssel. Einen verlorenen oder offengelegten Schlüssel widerrufst du in der Schlüsselliste der Anwendung. Erstelle einen neuen, statt das Geheimnis wiederherstellen zu wollen.
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 Hosting-URL oder zum Erneuern ihrer Kennung nutzt du das Panel aus Remote-Mocks. Der Widerruf eines eck_-Schlüssels deaktiviert diese URL nicht.