API-Credits

API-Credits werden bei Multi-Step API (MSA)- und Postman API-Prüfobjekten verwendet, um API-Endpunkte zu testen, die mehrere aufeinanderfolgende HTTP-Abfragen erfordern.

API-Credits

API-Credits werden auf Basis einer Anzahl an HTTP-Abfragen berechnet, die ein Prüfobjekt an einen Webserver oder einen API-Endpunkt sendet. Eine HTTP-Abfrage erfolgt, wenn ein Client Daten abruft oder sendet, etwa beim Laden einer HTML-Seite, Erstellen einer neuen Ressource oder Aktualisieren eines Datenbankeintrags. Jedes API-Prüfobjekt, das du erstellst und aktivierst (in Produktion oder Staging-Modus) enthält entweder eine oder eine verbundene Reihe an HTTP-Abfragen.

Bei Multi-Step API-Prüfobjekten benötigt jeder Abfrageschritt einen Credit. Warte-Schritte sind kostenfrei und benötigen keine Credits. Bei Postman API-Prüfobjekten erfordert jede Abfrage in deiner Sammlung einen Credit.

Berechnung: 1 Credit = 1 HTTP-Abfrage = 1 Schritt im Prüfobjekt

Anders als bei Verfügbarkeits- und Browser-Prüfobjekten wirkt sich die Anzahl erstellter API-Prüfobjekte nicht auf den Credit-Verbrauch aus. Credits werden auf Basis der Anzahl von API-Schritten berechnet, nicht nach Anzahl von Prüfobjekten. Überwachungsintervalle wirken sich auch nicht auf den Credit-Verbrauch aus.

Multi-Step API – Beispiele

Basic-Authentifizierung

Nehmen wir an, du möchtest überwachen, dass deine End-to-End-Authentifizierung korrekt funktioniert. Du hast zwei API-Endpunkte, sodass Nutzer einen Token zur Identifizierung abrufen und seine Gültigkeit prüfen können.

• POST /requestToken – Endpunkt, um das Token abzurufen. Nutzer senden in der Regel ihren Benutzernamen und ihr Passwort, um das Token abzurufen.
• GET /validateToken – Endpunkt, um das Token zu validieren.

In diesem Fall musst du ein einzelnes API-Prüfobjekt erstellen, das dem Vorgang in Reihenfolge folgt. Führe dazu die folgenden Schritte aus:

• Schritt 1: /requestToken
• Schritt 2: /validateToken

In diesem Szenario benötigst du zwei API-Credits, da das Prüfobjekt zwei Abfragen ausführt: Senden von Information (Anmeldedaten), um ein Token anzufordern, und Abfrage der Verifizierung dieses Tokens.

Komplexer API-Ablauf für Bestellsystem

Nehmen wir an, du verfügst über eine API, die ein großes Verzeichnis an Versanddaten für dein Transportgeschäft enthält. Dein Kundendienstteam erhält viele Anfragen zur Adressänderung aufgrund nicht korrekter Ziele. Um sicherzustellen, dass dieser Vorgang immer wie erwartet im Backend funktioniert, sollten wir diesen Workflow überwachen.

Dafür muss ein Prüfobjekt erstellt werden, dass mehrere Endpunkte umfasst:

• GET /allOrders
• Warte-Schritt
• GET /allOrders/{orderId}
• PATCH /allOrders/{orderId}

In diesem Szenario werden drei API-Credits verbraucht, da das Prüfobjekt HTTP-Abfragen an die GET und PATCH-Endpunkte sendet. Der Warte-Schritt erfordert keine Credits, da keine Abfrage an den Server gesendet und nur eine Verzögerung zwischen zwei Abfragen eingefügt wird.

Komplexe API-Abläufe mit mehreren Endpunkten

Nehmen wir an, dass du zwei unterschiedliche API-Abläufe wie zum Beispiel Prozesse im Bestellsystem und bei der Bezahlungsverarbeitung überwachen möchtest. Du hast zwei MSA-Prüfobjekte mit folgendem Ablauf erstellt:

• Prüfobjekt A: Bestellsystem – enthält drei unterschiedliche Abfrageschritte, um Bestelldaten zu prüfen und ein bestimmtes Bestelldetail zu bearbeiten:

  a. GET /allOrders

  b. GET /allOrders/{orderId}

  c. PUT /allOrders/{orderId}

• Prüfobjekt B: Bezahlvorgang – enthält vier Abfrageschritte, um die Bezahlung zu prüfen:

  a. POST /api/authentication

  b. POST /api/payment/validation

  c. Warte-Schritt

  d. POST /api/payment/process

  e. Warte-Schritt

  f. GET /api/payment/status

In diesem Szenario verbraucht Prüfobjekt A 3 Credits und Prüfobjekt B 4 Credits. Jeder Abfrageschritt berechnet einen Credit. (3 + 4 = 7 HTTP-Abfragen).

Beispiele für Postman APIs

E-Commerce-Überwachung

Nehmen wir an, du möchtest deine E-Commerce-Plattform überwachen und testen, ob die Bezahlungsabläufe korrekt funktionieren. Du hast deine Postman Sammlung exportiert und in Uptrends hochgeladen. Uptrends erkennt die folgenden Abfragen:

• GET /allOrders
• GET /allOrders/{orderId}
• PUT /allOrders/{orderId}

Es entstehen bei diesem Szenario insgesamt 3 Credits. Jede Abfrage wird als ein Credit gezählt.

Datenverarbeitung

Nehmen wir an, du möchtest deine End-to-End-Daten- und CI/CD-Abläufe überwachen. Du möchtest eine Verbindung von einer Datenquelle erstellen, diese Daten abrufen sowie die rohen Daten zu einem verwendbaren Format für Analysen und Berichte vorbereiten und in deiner Datenbank speichern.

Du hast eine API URL für deine Postman Sammlung verwendet. Uptrends erkennt die folgenden Abfragen:

• POST /api/v1/datasources/connect
• GET /api/v1/datasources/{connectionId}/fetch
• PATCH /api/v1/pipelines/{pipelineId}/transform
• PUT /api/v1/pipelines/{pipelineId}/save

Es entstehen bei diesem Szenario insgesamt 4 Credits. Jede Abfrage wird als ein Credit gezählt.