Uzelf identificeren

Het is zeer belangrijk dat u het platform vertelt wie u bent en wanneer u aanvragen doet aan de API of anders wordt u behandeld als een anonieme gebruiker en verliest u speciale toegangsprivileges die u heeft bekomen voor portalen of datasets.

Opdat het platform weet wie u bent, moet u ofwel:

  • ingelogd zijn op een portaal en zoekopdrachten uitvoeren vanuit het portaal op het portaal (bijvoorbeeld door de console te gebruiken), of

  • een API-sleutel opgeven samen met uw aanvragen waarmee u op unieke wijze kan worden geïdentificeerd.d

API-sleutels genereren en terugvinden

Om de lijst met API-sleutels te zien, ga naar uw profielpagina op http://<youropendatasoftportal>.com/account/ (of klik op uw naam in de header).

Eenmaal u daar bent aangekomen, ga naar het tabblad met als titel Mijn API-sleutels om de lijst met uw actieve sleutels te zien, herroep deze en maak nieuwe aan.

Belangrijk

Hoewel u zoveel sleutels kan hebben als u wil, zullen ze u allemaal op identieke wijze identificeren. Dit betekent dat ze allemaal dezelfde rechten (die van u) verlenen aan elke persoon die ze gebruikt. Daarom mag u uw sleutels niet delen.

API-sleutels verschaffen in uw aanvragen

Nu u een API-sleutel heeft, kan u deze samen met uw aanvraag doorgeven via de zoekparameters apikey.

Om dit te illustreren, laten we zeggen dat u een privaat portaal hebt opgemaakt en dat u de lijst met datasets uit een externe bron die u aan het bouwen bent, wil ophalen.

Indien uw applicatie belt:

http://myprivateportal.opendatasoft.com/api/v2/catalog/datasets/

U krijgt een 403 Forbidden fout.

Terwijl wanneer u belt:

http://myprivateportal.opendatasoft.com/api/v2/catalog/datasets/?apikey=<myapikey>

U een JSON krijgt met de volledige lijst met datasets die beschikbaar zijn op het portaal.