1. Support
  2. Knowledge Base
  3. Uptrends' API
  4. Authenticatie (versie 4)

Authenticatie (versie 4)

We vernieuwen onze gebruikersinterface. Sommige informatie is nog niet aangepast. Lees meer.

Elke API-methode vereist authenticatie met een API-account, dus u moet er eerst een maken. Deze API-account is gebaseerd op uw Uptrends-account, maar is niet hetzelfde. Het voordeel van afzonderlijke accounts is dat u de API-inloggegevens gebruikt binnen bijv. scripts en u uw Uptrends-accountgegevens niet hoeft te vermelden.

Met de POST-methode van het /Register-eindpunt kunt u een nieuwe API-account creëren. In de beschreven stappen gebruiken we de Swagger-omgeving voor rechtstreekse toegang tot de API. De API-account die we nu gaan maken, verloopt niet, dus u hoeft dit maar één keer te doen.

Een API-account registreren

  1. Ga naar de Swagger-pagina, zoek de methode POST/Register en vouw deze uit.

  2. Klik op de knop Try it out om een API-account te maken.

  3. Klik op de knop Execute.

  4. Uw browser vraagt nu om de inloggegevens van uw Uptrends-operator. Vul het e-mailadres en wachtwoord in dat u normaal gesproken gebruikt om toegang te krijgen tot Uptrends en klik op OK.

  5. Nadat de inloggegevens van uw Uptrends-account zijn geverifieerd, bevat de Response body de waarden voor UserName en Password.

    {
       "UserName": "usernamehere",
       "Password": "passwordhere",
       "AccountId": "123456",
       "OperatorName": "Your name",
       "status": "OK"
    }
    

    Dit zijn de inloggegevens van uw nieuwe API-account.

  6. Klik op de knop Download in de Response body om deze inloggegevens op te slaan en ze op een veilige plaats te bewaren. Gebruik ze als authenticatie voor alle andere API calls.

Opmerking: de API-account verloopt niet. Maar als u uw inloggegevens kwijtraakt, kunnen die niet worden teruggehaald. U moet dan een nieuw API-account maken.

Gebruik van uw API-account

Nu u een API-account hebt, kunt u deze gaan gebruiken. Als u Swagger gebruikt, voert u de inloggegevens in een dialoogvenster in. In software als cURL of Postman verstrekt u ze als headers en wordt voor de benodigde codering gezorgd. Als u uw eigen scripts gebruikt, moet u uw inloggegevens eerst coderen, zie het gedeelte Basisauthenticatie.

Opmerking: onthoud dat deze API-account gekoppeld is aan uw Uptrends-operatoraccount, dus deze heeft dezelfde bevoegdheden als in uw Uptrends-account.

Swagger-omgeving

Als u API-methoden uitvoert in de Swagger-omgeving, verschijnt er een venster Sign in (verwijzend naar https://api.uptrends.com) waar u de gebruikersnaam en het wachtwoord van uw API-account moet invoeren.

Basisauthenticatie

De inloggegevens van de account moeten altijd worden gecodeerd met behulp van het basisauthenticatieschema en als specifieke header aan de API worden verstrekt.

Software zoals Postman, cURL, etc. zorgt ervoor dat de inloggegevens worden gecodeerd en correct worden verstrekt. Als u uw eigen script schrijft, moet u deze header opgeven voor de API-aanroep:

Authorization: Basic {{encoded credentials}}

De inloggegevens moeten base64-gecodeerd zijn. Volg deze stappen om de header te maken:

  1. Definieer een tekenreeks met de syntaxis username:password, waarbij u username en password vervangt door uw inloggegevens. Voeg geen spaties toe.

  2. De tekenreeks username:password moet base64-gecodeerd zijn. De coderingsfunctionaliteit kan opgenomen zijn in uw software of scripttaal of u gebruikt een tool als https://www.base64encode.org/.

  3. Zodra u de gecodeerde tekenreeks hebt, maakt en gebruikt u een header Authorization: Basic {{encoded credentials}}, waarbij de encoded credentials de met base64 gecodeerde tekenreeks uit de vorige stap is.

Door deze website te gebruiken, stemt u in met het gebruik van cookies in overeenstemming met ons Cookiebeleid.