Met de Uptrends API kunt u op een geautomatiseerde manier met uw Uptrends-account werken: u kunt scripts bouwen die uw monitoringconfiguratie wijzigen en u hebt toegang tot uptime- en performancedata om uw eigen rekenwerk te doen. Momenteel onderhouden we twee API-versies:

  • Versie 3 bestaat al lang en bevat methodes voor het creëren en bijwerken van uw controleregels (behalve transactie- en multi-step API-controleregels), het onderhouden van controleregelgroepen, het ophalen van de huidige status en statistieken voor uw controleregels en het downloaden van informatie over de locaties van onze controlestationservers (inclusief IP-adressen). Lees de volledige documentatie over API v3.
  • Versie 4 is onlangs geïntroduceerd en zal blijven groeien. U hebt deze versie nodig als u wijzigingen wilt aanbrengen bij transactie- en multi-step API-controleregels, en voor het dupliceren van elk type bestaande controleregel. Lees volledige documentatie over API v4 en onderzoek onze OpenAPI-specificatie en Swagger-omgeving.

Het is prima om beide API's naast elkaar te gebruiken, maar houd er rekening mee dat er enkele verschillen zijn in de manier waarop u toegang hebt tot elk van de versies, in de gebruikte terminologie en in de manier waarop data zijn georganiseerd.

Verschillen in authenticatie

Beide versies zijn REST API's die vereisen dat u inloggegevens verstrekt met een Basic Authentication HTTP header.

  • Bij versie 3 verstrekt u elke keer dat u toegang tot de API wilt de gebruikersnaam (= e-mailadres) en het wachtwoord van een Uptrends-operator. Elke operator kan worden gebruikt, maar om data te wijzigen zijn administratorrechten nodig.
  • Bij versie 4 moet u eerst een API-account creëren door de gebruikersnaam en het wachtwoord van uw Uptrends-operator op te geven. Hierdoor worden afzonderlijke API-inloggegevens gegenereerd, die u voor alle toekomstige API calls kunt gebruiken. Een API-account verloopt niet, dus u hoeft deze maar één keer te creëren. Onthoud dat een API-account is gekoppeld aan de operator die de account heeft gecreëerd, dus deze zal alleen werken met zijn toegangsgegevens.