Postman API-Variablen

Wenn du gerade erst das Postman API-Monitoring aufnimmst, empfehlen wir dir, den Überblicksartikel zum Postman API-Monitoring zu lesen, um mehr zu den wichtigsten Funktionen und Merkmalen zu erfahren.

Dieser Artikel erläutert, wie Variablen aus deiner Postman-Sammlung erfasst werden und wie du ihre Werte zur Nutzung im gesamten API-Szenario ausfüllen lassen kannst.

Variablen

Variablen in Postman werden verwendet, um Werte zu speichern und in unterschiedlichen Anfragen, Skripten und Umgebungen wiederzuverwenden. Mit ihnen kannst du dynamische Daten wie Authentifizierungs-Tokens, API-Schlüssel oder jeden anderen Wert, der sich mit der Zeit oder zwischen unterschiedlichen Umgebungen ändert, handhaben.

Wenn du eine Postman-Sammlung importierst, die Variablen wie {{VariableName}} in Anfragen, Skripten oder Umgebungen nutzt, erkennt das Postman API-Prüfobjekt diese automatisch und erstellt vordefinierte Variablen für dich. Diese Variablen werden im Bereich Variablen des Prüfobjekteditors gelistet und du brauchst nur ihren Wert einzugeben. Das ist nützlich, um die Authentifizierung ganz einfach bei APIs erfolgen zu lassen, die einen Benutzernamen, Passwort oder geheimen Schlüssel erfordern.

Einsatzbereich:

Nehmen wir an, du hast eine Postman-Sammlung mit einem API-Endpunkt importiert: GET {{baseUrl}}/{{secretkey}}/.... Diese GET-Anfrage ermöglicht dir, anhand deines geheimen Schlüssels als Anmeldeinformation eine Authentifizierung aus unterschiedlichen Umgebungen vorzunehmen.

Als Teil der Anfrage erkennt das Prüfobjekt, dass zwei Variablen, {{baseUrl}} und {{secretkey}, in deiner Sammlung definiert sind. Diese Variablen werden automatisch erzeugt und unter den Variablen des Prüfobjekteditors angezeigt. Du kannst ihre Werte ganz einfach eingeben oder weitere Variablen basierend auf den Anforderungen deiner Überwachung hinzufügen.

Wie im Bild zu sehen ist, wurden vier Variablen erstellt: zwei automatisch vom Prüfobjekt und zwei, die von dir definiert wurden.

• prodEnvironment und testEnvironment sind benutzerdefinierte Variablen, die URLs von Produktions- und Testumgebungen speichern. Diese werden manuell hinzugefügt und können im gesamten API-Szenario mit der Syntax {{VariableName}} verwendet werden.
• Die Variable baseUrl wurde automatisch erstellt und vom Prüfobjekt identifiziert. Sein Wert wurde auf {{prodEnvironment}} gesetzt, sodass sie in der Produktionsumgebung genutzt werden kann. Wenn du das Testen in der Testumgebung ausführen möchtest, ersetze {{prodEnvironment}} durch {{testEnvironment}}. Damit kannst du schnell zwischen den Umgebungen wechseln, ohne deine Sammlung oder einzelne Anfragen manuell zu ändern.
• Die Variable secretkey wurde automatisch erstellt und vom Prüfobjekt identifiziert. Sie enthält einen Wert aus der Vault, genauer gesagt ein Passwort aus einem Credential Set.

Variablen einrichten

Sobald du deine Postman-Sammlung importiert hast, kannst du Variablen einen Wert entweder mit Klartext oder über die Vault zuweisen.

Variablen einen Wert mit Klartext zuweisen

Um Variablen einen Wert mit Klartext zuzuweisen:

1. Gehe zu den Variablen.
2. Identifiziere die Variable, der du einen Wert zuweisen möchtest. Klicke auf .
3. Wähle Klartext.
4. Gib einen Text oder eine Variable in das Feld Klartext. Zum Beispiel: https://test.yourapi.com oder {{VariableName}}.
5. Klicke auf Auswählen.

Jedes Mal, wenn das Prüfobjekt ausgeführt wird, nutzt es den von dir angegebenen Wert. Gibst du baseUrl als https://test.yourapi.com an, wird die API-Anfrage an https://test.yourapi.com/... gesendet. Setzt du den secretkey auf {{secretKeyVariable}}, wird dies als Wert der Variable genutzt.

Variablen einen Wert über Vault Items geben

Variablen können auch Vault Items speichern, die sensible Daten aus der Uptrends Vault enthalten.

Um Variablen einen Wert anhand Vault Items zuzuweisen:

1. Stelle sicher, dass die Anmeldedaten in deiner Uptrends Vault hinzugefügt wurden.
2. Identifiziere die Variable, der du einen Wert zuweisen möchtest. Klicke auf .
3. Wähle Vault Anmeldedaten.
4. Wähle ein Credential Set zusammen mit seinem Wert. Wähle zum Beispiel einen Benutzernamen oder ein Passwort.
5. Klicke auf Auswählen.

Jedes Mal, wenn das Prüfobjekt ausgeführt wird, nutzt es den von dir angegebenen Wert. Wenn du das Passwort aus dem Credential Set nutzt, wird der {{secretkey}} den Wert Password from the vault enthalten.