Als u al eerder een API hebt gebruikt, zullen veel van de concepten u bekend voorkomen.
Alle API-oproepen naar DATA-collectief moeten worden gedaan naar het basisdomein: https://api.datacollectief.nl
JSON wordt standaard teruggestuurd in alle antwoorden van de API. U kunt ook XML antwoorden ontvangen i.p.v. JSON wanneer u in de header van elk bericht Accept application/xml meegeeft.
De API's zijn ontworpen om voorspelbare, duidelijke URL's te hebben en HTTP-antwoordcodes te gebruiken om API-fouten aan te geven.
Om de API te kunnen gebruiken dient er eerst een account aangemaakt te worden op de Mijn DATA-collectief website indien deze nog niet eerder aangemaakt is.
Klik hier om een account aan te maken : Aanmelden Mijn DATA-collectief
Vervolgens kunt u een e-mail sturen naar support@datacollectief.nl met daarin een vraag om het account te koppelen aan de API.
In de e-mail dient alleen het e-mailadres van het desbetreffende account te worden meegestuurd.
Het authenticatiemodel bestaat uit drie onderdelen:
| User | Het e-mailadres, behorend bij het Mijn DATA-collectief account is de User voor het aanroepen van functies in de API. |
| Password | Het wachtwoord voor het gebruik van de API. Het betreft hier niet het wachtwoord dat wordt gebruikt voor het inloggen in Mijn DATA-collectief, maar een wachtwoord dat wordt aangemaakt voor de specifieke combinatie User/ApplicationName. Dit wachtwoord wordt aangemaakt door medewerkers van DATA-collectief en kan niet door de gebruikers worden gewijzigd. |
| ApplicationName | Een applicatie die gebruik wil maken van de API moet bij Mijn DATA-collectief als application zijn geregistreerd. Wanneer een functie in de API wordt aangeroepen, zal deze ApplicationName in de aanroep moeten worden opgenomen. |
Er zijn 2 request (Company en Contact) waarbij credits worden verrekend, het opvragen van een volledige set data van een bedrijf of een contactpersoon welke nog niet in uw bezit is kost 1 credit.
Een bedrijf of contactpersoon blijft na de download 30 dagen in uw bezit, daarna zal er opnieuw een credit worden gerekend indien u geen actualisatie abonnement heeft.
De API geeft een melding indien er geen credits meer aanwezig zijn bij het account.
U kunt credits verkrijgen via onze webshop : https://shop.datacollectief.nl/
Er is een request genaamd "DownloadStatistics" waarin bij een licentie opgevraagd kan worden wat het huidige creditsaldo is, en waaraan tot nu toe credits zijn besteed.