In [Beheer] > [API sleutels] kun je API sleutels aanmaken, aanpassen en verwijderen. Deze sleutels worden gebruikt om HTTP requests te kunnen uitvoeren via onze Datahub API.
¶ API Sleutels bekijken
Als je naar de "API sleutels" sectie navigeert in het linkermenu, zie je een overzicht van alle beschikbare API sleutels. Rechtsboven kun je het zoekveld gebruiken om te zoeken in de verschillende API sleutels.
Om een nieuwe API sleutel aan te maken voor onze Datahub API kun je klikken op de "Toevoegen"-knop rechtsboven in het scherm.
Aan het einde van elke rij zie je de onderstaande drie knoppen. Met deze knoppen kun je (van links naar rechts) de API sleutel bekijken, wijzigen of verwijderen.
¶ Sleutel toevoegen
Je kunt een nieuwe API sleutel toevoegen door op de "Toevoegen"-knop te drukken. Zorg ervoor dat je de sleutel veilig bewaart en niet deelt met onbevoegde personen.
Naam
De naam van de API sleutel. Deze naam wordt gebruikt om de sleutel te identificeren in het overzicht.
Geldig tot datum
De datum waarop de API sleutel verloopt. Vanaf deze datum kan de API sleutel niet meer gebruikt worden. Wanneer het veld leeg wordt gelaten, dan is de API sleutel onbeperkt geldig.
Gebruikersrol
- Alleen-lezen gebruiker: kan data ophalen voor de geselecteerde dataset groepen.
- Beheerder: kan alles binnen de omgeving inzien.
Dataset groepen
De dataset groepen waarvoor de API sleutel gebruikt kan worden. De API sleutel kan alleen data ophalen voor de geselecteerde dataset groepen.
¶ Sleutel wijzigen
Door op de "Wijzigen"-knop te klikken bij een specifieke API sleutel, kun je de sleutel aanpassen. Dit stelt je in staat om bijvoorbeeld de naam of de machtigingen van de sleutel te wijzigen. Ook is het mogelijk om de X-Api-Key in te zien, maar deze kan niet worden aangepast. Als je de sleutel toch zou willen wijzigen, dan kun je een nieuwe sleutel aanmaken en de oude sleutel verwijderen.
¶ Sleutel verwijderen
Met de "Verwijderen"-knop kun je een API sleutel permanent verwijderen. Er zal eerst een pop-up verschijnen met de vraag of je zeker weet dat je de sleutel wil verwijderen. Wees voorzichtig bij het verwijderen van sleutels, omdat gekoppelde applicaties na het verwijderen geen toegang meer.
¶ API Sleutel Documentatie
De API sleutels worden gebruikt om requests te doen naar de MeterInsight API. Raadpleeg de API documentatie op https://app.swaggerhub.com/apis/meterinsight/meterinsight/ voor gedetailleerde informatie over de beschikbare endpoints, parameters en de verwachte respons.