Uptrends' API-controleregels kunnen een enkele respons controleren of complexe multi-step API calls verwerken. In deze les leert u de basis van het configureren van een API-controleregel.

Welke types API-controleregels zijn er?

  • Webservice HTTP/HTTPS
    De Webservice HTTP/HTTPS-controleregels kunnen een enkele respons testen. We raden aan Webservice-controleregels te gebruiken om de beschikbaarheid en uptime van een API te controleren met basisauthenticatie en contentcontroles. Meer informatie over Webservice-controleregels vindt u in onze Knowledge Base.
    Opmerking: Bezoek de les over Beschikbaarheids-controleregels als u wilt weten hoe u Webservice-controleregels configureert, of bezoek onze Knowledge Base voor gedetailleerde informatie over Webservice-controleregels.
  • Multi-step API
    Voor het verwerken van redirects, het verwerken van authenticatie, het uitvoeren van meerdere API calls, of het hergebruiken van waarden van een API call in een andere, moet u een Multi-step API-controleregel gebruiken. Blijf voor informatie over de basisconfiguratie gewoon verder lezen, maar u vindt meer configuratiedetails in onze Knowledge Base.

Creëer een Multi-step API-controleregel

Houd uw API-documentatie bij de hand tijdens het configuratieproces.

  1. Klik op de knop + Controleregel toevoegen in het menu Controleregels op het hoofdmenu om het configuratiescherm Nieuwe controleregel te openen.
  2. Selecteer Multi-step API bij Type.
  3. Geef uw controleregel een Naam.
  4. Stel de Controlefrequentie in.
  5. Schakel naar het tabblad Stappen.

Oké, nu staan we eerst even stil bij wat we bedoelen met een stap.

Wat is een stap?

Een stap in Multi-step API monitoring bestaat uit één round-trip call naar de API (d.w.z. één request en één respons). Binnen elke stap kunt u uw request definiëren en Uptrends vertellen hoe met de respons moet worden omgegaan. Elke Multi-step API begint met één lege stap. Laten we die invullen.

Een request configureren

Wanneer u schakelt naar het tabblad Stappen van uw Multi-step API-controleregel, ziet u één stap in de kolom Stappen, maar u ziet dat zowel de Request als Response (aan de rechterkant) beiden leeg zijn voor die stap. Laten we dat veranderen.

De pagina is standaard ingesteld op de Request (rechterkolom).

  1. Kies uw HTTP Method en voeg de URL toe. De methode is standaard ingesteld op GET, maar als u POST, PUT of Delete kiest, verschijnt er een tekstveld waar u uw request body kunt invoeren.
  2. Klik op Request header toevoegen om de naam en waarde van uw request header te definiëren ( lees meer).
    Gewone headers bevatten combinaties van naam/waarden:

    - Accept gecombineerd met application/json or text/xml, of application/x-ww-form-urlencoded

    - Content-Type met application/json of text/xml of application/x-ww-form-urlencoded

    - Authorization met de juiste data in het veld Waarde.
    Opmerking: Als u dezelfde waarde meerdere keren moet gebruiken, kunt u die waarde toevoegen aan het gedeelte voorgedefinieerde variabelen aan de onderzijde van het scherm Stappen. Meer informatie over voorgedefinieerde variabelen vindt u in de Knowledge Base.
  3. Configureer de Authenticatie, Clientcertificaat, plaats een vinkje bij TLS/SSL certificaatproblemen negeren als u geen berichten wilt ontvangen over dit soort fouten en voer een Stapomschrijving in.

Omgaan met de respons

Nadat Uptrends de request verstuurt, moeten we weten wat u wilt dat wij doen met de respons, dus laten we nu kijken naar uw opties voor het omgaan met een respons.

  1. Klik op Response boven aan de kolom.
  2. Klik op Assertion toevoegen (lees meer).
  3. Selecteer het responstype in het eerste menu. Uptrends gebruikt de keuze die u hier maakt om de rest van de assertionvelden te configureren. Onderzoek alle verschillende responstypes die u kunt kiezen. Voor uw eerste assertion, kunt u bijvoorbeeld Statuscode kiezen. Er zijn dan twee extra vakken die moeten worden ingevuld.
  4. Stel de vergelijkingsoperator in. We willen zeker weten dat de request succesvol was, dus kiezen we “Is gelijk aan.”
  5. Voer in het laatste vak de waarde in die u wilt controleren. In dit geval willen we zeker weten dat de request slaagt, dus stellen we die in op “200.”

  6. Ga naar eigen inzicht verder met het toevoegen van assertions.
  7. Voeg variabelen toe voor waarden die u mogelijk moet hergebruiken door op de knop Variabele toevoegen te klikken. Stel het responstype in, voeg de query of expressie toe en geef uw variabele een naam (leer hoe u variabelen gebruikt en definieert).
  8. Klik op Opslaan als uw controleregel slechts één request hoeft te doen of ga door met het toevoegen van stappen met de knop + Stap toevoegen in de linkerkolom.
    Opmerking: We hebben uitgebreide gedetailleerde instructies en voorbeelden in het gedeelte API Monitoring van de Knowledge Base.