Veel API's vereisen dat de caller authenticatie-informatie verstrekt om hun identiteit te verifiëren en mogelijk de toegangsrechten van die caller. Authenticatie-informatie kan worden doorgegeven met behulp van HTTP headers (Basic/NTLM/Digest-authenticatie), door uitwisselen van access tokens (OAuth), door de cliënt te verplichten een cliëntcertificaat op te nemen in de request, of een combinatie hiervan.

In dit artikel worden de opties voor cliëntcertificaten besproken. Meer informatie over het instellen van traditionele authenticatiemethoden vindt u in het artikel over authenticatietypes.

Types cliëntcertificaten

Het gedeelte Cliëntcertificaten op het tabblad Stappen van een Multi-step API-controleregel biedt de volgende opties. Als u meerdere stappen gebruikt in uw stapdefinitie, zorg er dan voor dat u de gewenste instellingen voor elke stap weet.

  • Uptrends cliëntcertificaat: Deze optie is handig als u van uw API-gebruikers eist dat zij hun eigen cliëntcertificaat genereren en meesturen om hun identiteit te bewijzen. Als u deze optie kiest, wordt er een certificaat dat eigendom is van Uptrends meegestuurd als de HTTP request wordt verzonden. Uw API kan die inkomende request verifiëren met behulp van de bijbehorende public key. Als deze overeenkomt, kunt u er zeker van zijn dat de request afkomstig is van iemand die eigenaar is van het originele certificaat (d.w.z. Uptrends), en niemand anders. Lees voor meer informatie het artikel Informatie over Uptrends' public key.
  • Eigen cliëntcertificaat: Gebruik deze optie als u de eigenaar of beheerder bent van het cliëntcertificaat dat met de request meegestuurd moet worden. Nadat u het certificaat naar Uptrends hebt geüpload kunt u het in uw Multi-step API-controleregels opnemen. Aangezien u eigenaar bent van dat certificaat, zal uw API in staat zijn inkomende requests die het gebruiken te verifiëren. In het volgende gedeelte leest u hoe u dit instelt.
  • Geen: Kies Geen als u geen cliëntcertificaat wilt opnemen in uw HTTP request.

Een eigen cliëntcertificaat instellen

Om een cliëntcertificaat op te nemen in uw Multi-step API-controleregels moet u het eerst naar uw Uptrends-account uploaden. Certificaten (en andere gevoelige informatie) worden geüpload naar en opgeslagen in uw Vault. Nadat u een certificaat aan uw vault hebt toegevoegd, kunt u het gaan gebruiken bij de configuratie van uw controleregel.

Een cliëntcertificaat uploaden

Als u de optie Eigen cliëntcertificaat voor het eerst gebruikt, ziet u dat er nog geen certificaten beschikbaar zijn. Om er een toe te voegen kiest u Certificaat toevoegen om naar de vault te gaan. Of kies Account > Vault in het hoofdmenu en klik op Vault-item toevoegen.

Vul in het scherm Nieuw vault-item een unieke naam in voor het certificaat, zodat u het later herkent. Zorg ervoor dat in het menu Type de optie Certificaatarchief is ingesteld voor het nieuwe vault-item. Voeg optioneel opmerkingen toe in het veld Omschrijving.

Tot slot specificeert u het certificaat dat u wilt uploaden. Het bestand moet een PKCS #12-bestand, of certificaatarchief, zijn dat zowel de private key als de public key bevat. PKCS #12-bestanden hebben de bestandsextensie .pfx of .p12.

Een certificaatarchiefbestand wordt meestal versleuteld, dus hebben we het bijbehorende wachtwoord nodig om het te kunnen gebruiken. Specificeer het wachtwoord in het veld Wachtwoord van het archief en klik op Opslaan.

Een cliëntcertificaat gebruiken in een Multi-step API-controleregel

Nadat u een geschikt cliëntcertificaat in de vault hebt opgeslagen, kunt u het gaan gebruiken in een Multi-step API-controleregel. In het gedeelte cliëntcertificaat van een stap kunt u op Verversen klikken om de lijst met beschikbare certificaten opnieuw te laden. Selecteer tot slot het juiste certificaat in elke stap die het nodig heeft.