Aan de slag
Welkom bij het API developer portaal van Waternet! Waternet biedt een verzameling van APIs aan waarmee je onze services kunt integreren in jouw applicaties.
Op deze pagina wordt stap voor stap uitgelegd hoe je de Waternet APIs kunt gebruiken.
APIs
In het API overzicht zie je een lijst van beschikbare APIs. Daarnaast is een korte omschrijving van de API weergegeven. Met behulp van de zoekbalk kan je zoeken naar de voor jou relevante API. Iedere API is voorzien van documentatie (parameters, voorbeeld-request etc.).
Wil je gebruik maken van de API? Vraag dan toegang aan via het product. Lees hieronder hoe.
Inloggen
Voordat je de beschikbare APIs en Producten kunt zien heb je een account nodig.
Ga naar de inlogpagina
Log in met je gebruikersnaam en wachtwoord.
Product + (subscription) key
Een product is een bundel van één of meerdere APIs. Welke producten er allemaal zijn, vind je hier.
Toegang tot een API wordt geregeld via een product. Om toegang te krijgen tot een API, en er vervolgens gebruik van te kunnen/mogen maken, heb je een abonnement sleutel (subscription key) nodig. Zie deze sleutel/key als je persoonlijke toegangs-, en identificatiesleutel tot de API. De toegang (en dus sleutel) vraag je aan via het product. Het wordt dan ook de product subscription key genoemd.
Hieronder lees je de stappen om een (subscription) key te bemachtigen:
Via producten
Ga naar het product waaronder de API aangeboden wordt.
Dit kan op de volgende manier:
Via de producten pagina en klik op het gewenste product. Kies deze optie als je weet onder welk product de API aangeboden wordt.Via de API pagina.
Selecteer het product linksonder op de API pagina onder 'Related Products'. Je wordt direct doorgelinkt naar de betreffende product pagina.
Via subscripties
Onder het kopje 'jouw subscripties' zie je of je al een subscription hebt, en zo niet dan kan je er een aanvragen via de Subscribe button.
Om een subscription aan te vragen doe je het volgende:
Vul een naam in voor je subscription. Advies: vul de naam in van het product. Deze naam zal ook te zien zijn op je profiel pagina binnen de sectie 'Abonnementen'. Klik op Subscribe om de aanvraag in te schieten.
Je wordt vervolgens geleid naar je persoonlijke profiel pagina waar je de status van de aanvraag kan vinden. Daarnaast krijg je een automatisch gegenereerde e-mail met een bevestiging van je inschrijvingsverzoek op dit product. De eigenaar van de API je verzoek beoordelen.
Product (subscription) key
Zodra je (subscription) aanvraag is goedgekeurd vind je op je profiel pagina de toegewezen persoonlijke subscription key. Deze key dien je tijdens elke request(bericht) mee te sturen. Je kunt op de Try-It pagina van de API (operation) zien hoe de key als Header meegegeven dient te worden.
Er kunnen nog extra beveiligingstoepassingen actief zijn om de API (operatie) succesvol te kunnen aanroepen. Mocht dit het geval zijn dan zul je deze zien op de API pagina / definitie, of te horen krijgen van de API eigenaar.
Specifieke product/API vragen?
Mocht je Product of API vragen/verzoeken/opmerkingen hebben, neem dan contact op.