API-credits

API-credits worden gebruikt door de controleregels Multi-step API (MSA) en Postman API om API-eindpunten te testen die meerdere opeenvolgende HTTP-requests vereisen.

API-credits

API-credits worden berekend op basis van het aantal HTTP-requests dat een controleregel naar een webserver of API-eindpunt verzendt. Een HTTP-request vindt plaats wanneer een client data ophaalt of verzendt, zoals het laden van een HTML-pagina, het creëren van een nieuwe resource of het bijwerken van een database-item. Elke API-controleregel die u creëert en activeert (in production- of stagingmodus) bevat één of meerdere, geketende HTTP-requests.

Voor multi-step API-controleregels verbruikt elke requeststap één credit. Wachtstappen zijn gratis en verbruiken geen credits. Voor Postman API-controleregels verbruikt elke request in uw collection één credit.

Berekening: 1 credit = 1 HTTP-request = 1 stap in de controleregel

In tegenstelling tot uptime- en browsercontroleregels heeft het aantal gecreëerde API-controleregels geen invloed op het creditverbruik. Credits worden berekend op basis van het aantal API-stappen, niet op het aantal controleregels. Controle-intervallen hebben ook geen invloed op het creditverbruik.

Voorbeelden Multi-step API

Basisauthenticatie

Stel dat u wilt monitoren of uw end-to-end-authenticatie correct werkt. U heeft twee API-eindpunten waarmee gebruikers een token kunnen aanvragen voor identificatie en de geldigheid ervan kunnen verifiëren:

• POST /requestToken — eindpunt om het token te krijgen. Gebruikers sturen meestal hun gebruikersnaam en wachtwoord om een token aan te vragen.
• GET /validateToken — eindpunt om het token te valideren.

In dit geval moet u één API-controleregel creëren die het proces sequentieel volgt. Voltooi hiervoor de volgende stappen:

• Stap 1: /requestToken
• Stap 2: /validateToken

In dit scenario verbruikt u twee API-credits, omdat de controleregel twee requests uitvoert: om informatie (inloggegevens) te verzenden voor het aanvragen van een token en om verificatie van dat token aan te vragen.

Complexe API-workflow voor een bestelsysteem

Stel dat u een API heeft met een groot aantal verzendgegevens voor uw transportbedrijf. Uw klantenserviceteam ontvangt altijd veel tickets om de verzendadressen van klanten bij te werken vanwege onjuiste bestemmingen. Om ervoor te zorgen dat dit proces in de backend altijd naar behoren werkt, willen we deze workflow volgen.

U moet één controleregel met verschillende eindpunten creëren:

• GET /allOrders
• Wachtstap
• GET /allOrders/{orderId}
• PATCH /allOrders/{orderId}

In dit scenario verbruikt u drie API-credits omdat de controleregel HTTP-requests naar de GET- en PATCH-eindpunten verzendt. De wachtstap verbruikt geen credits, omdat deze geen request naar de server verzendt en alleen een vertraging tussen twee requests toevoegt.

Complexe API-workflow met meerdere eindpunten

Stel dat u twee verschillende API-workflows wilt monitoren, zoals een bestelsysteem en betalingsverwerking. U heeft twee MSA-controleregels gecreëerd met de volgende flow:

• Controleregel A: Bestelsysteem - bevat drie requeststappen om orderinformatie te controleren en een specifiek orderdetail te bewerken:

  a. GET /allOrders

  b. GET /allOrders/{orderId}

  c. PUT /allOrders/{orderId}

• Controleregel B: Betalingsverwerking - bevat vier requeststappen om betaling te controleren:

  a. POST /api/authentication

  b. POST /api/payment/validation

  c. Wachtstap

  d. POST /api/payment/process

  e. Wachtstap

  f. GET /api/payment/status

In dit scenario verbruikt Controleregel A drie credits en Controleregel B verbruikt vier credits. Elke requeststap telt als één credit. (3 + 4 = 7 HTTP-requests).

Voorbeelden Postman API

E-commerce monitoring

Stel dat u uw e-commerceplatform wilt monitoren om te testen of het betalingsproces correct werkt. U heeft uw Postman-collection geëxporteerd en geüpload naar Uptrends. Uptrends detecteert de volgende requests:

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

In dit scenario zijn er in totaal drie credits. Elke request telt als één credit.

Dataverwerking

Stel dat u uw end-to-end-data- en CI/CD-workflow wilt monitoren. U wilt een verbinding tot stand brengen vanuit een databron, die data ophalen en ruwe data voorbereiden in een bruikbaar formaat voor analyse of rapportage, en deze opslaan in uw database.

U heeft een API-URL gebruikt voor uw Postman-collection. Uptrends detecteert de volgende requests:

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

In dit scenario zijn er in totaal 4 credits. Elke request telt als één credit.