Business Cases
Voorbeeld flow |
Mijn DATA-collectief accounts koppelen |
|
[Account aanmaken] Mijn DATA-collectief account aanmaken  [Applicatie registreren] Applicatie registreren via account [RegisterAccount] Nieuw account koppelen |
Elke applicatie die gekoppeld is aan de DATA-collectief API heeft een hoofdaccount, dit is het account waarvoor de API koppeling oorspronkelijk is aangemaakt.
U kunt - met dat hoofdaccount als credentials - via het "RegisterAccount" request een nieuwe gebruiker koppelen aan uw applicatie:
De nieuwe gebruiker dient zich altijd eerst te hebben aangemeld bij het "Mijn DATA-collectief".
De applicatie dient door de gebruiker vervolgens eerst geactiveerd te worden door in te loggen in Mijn DATA-collectief en het scherm "Mijn applicaties" te openen.
De gebruiker heeft via "Mijn applicaties" ook de mogelijkheid om de koppeling weer te verbreken.
Er wordt een unieke "code" aangemaakt voor de koppeling die benodigt is voor de "registeraccount" call.
Het e-mailadres van dat nieuwe Mijn DATA-collectief account wordt de 'newUser' voor de "registeraccount" call.
Vanuit de call krijgt u deze user en het bijbehorende wachtwoord terug.
Vervolgens moeten alle andere calls van de gebruiker wordt uitgevoerd met die nieuwe user/wachtwoord combinatie. Alle downloads en credits zullen in Mijn DATA-collectief worden verwerkt van het nieuwe account i.p.v. het hoofdaccount. |
Voorbeeld flow |
Bedrijven zoeken en downloaden |
|
[DownloadStatistics] Optioneel controle credits [CompanyList] Bedrijven zoeken [Company] Bedrijf downloaden |
U kunt via het request “CompanyList” bedrijven zoeken in het DATA-collectief, het zoeken gebeurt o.b.v. diverse zoekvelden. In het request hoeft u alleen de velden mee te geven die nodig zijn voor de zoekcriteria.
Dit request werkt met paginering u dient hiervoor een paginanummer en het aantal resultaten per pagina op te geven, tevens kunt u aangeven op welk veld er gesorteerd moet worden.
Het is mogelijk om op een deel van de bedrijfsnaam en de plaats te zoeken door een ‘*’ te gebruiken, u kunt dus bijvoorbeeld het bedrijf DATA-collectief vinden wanneer u bij de bedrijfsnaam zoekt op *ata-collectief*.
De response retourneert een pagina met bedrijven, per bedrijf komt deze beperkte set met velden terug:
|
Voorbeeld flow |
Contactpersonen zoeken en downloaden |
|
[DownloadStatistics] Optioneel controle credits [ContactList] Personen zoeken [Contact] Contactpersoon downloaden |
U kunt met het request “ContactList” via het DATA-collectief bedrijfsnummer alle beschikbare contactpersonen bij een bedrijf opzoeken.
De response is de complete lijst contactpersonen bij dat bedrijf, zonder paginering. Per contactpersoon komt deze beperkte set velden terug:
|
Voorbeeld flow |
Doelgroepselectie maken |
|
[DownloadStatistics] Optioneel controle credits [UrlCompanySelection] URL doelgroepselectie [CompanySelection] Bedrijvenselectie ophalen [Company] Bedrijf downloaden |
Een doelgroepselectie is een zoekopdracht o.b.v. bedrijfskenmerken, u kunt bijvoorbeeld een selectie maken van alle bedrijven binnen een specifieke branche in de provincie Zuid Holland.
De API biedt deze functionaliteit aan via een URL die opgevraagd kan worden via het “UrlCompanySelection” request, in de response krijgt u een URL met een uniek token.
De gebruiker kan op deze webpagina een nieuwe selectie aanmaken, de interface van de webpagina kan niet gewijzigd worden. De webpagina retourneert een uniek selectienummer dat gebruikt kan worden in het “CompanySelection” request. Dit request werkt met paginering u dient hiervoor een paginanummer op te geven, het aantal per pagina is niet instelbaar er zullen altijd 8 resultaten worden teruggegeven. De response retourneert een pagina met bedrijven, per bedrijf komt deze beperkte set met velden terug (zie response CompanyList). Hou bij dit request rekening met de beperkingen van de API, voor meer informatie over de beperkingen klik hier. 
|
Voorbeeld flow |
Actualiseren |
|
[DownloadStatistics] Optioneel controle credits [UpdatedCompanies] Lijst met bedrijven met mutatie opvragen [Company] Bedrijf downloaden [UpdatedContacts] Lijst met personen met mutatie opvragen [Contact] Contactpersoon downloaden |
Met het “UpdatedCompanies” request kan van een reeks bedrijven getoetst worden of er een mutatie op is.
De bedrijven worden getoetst o.b.v. een kommagescheiden string van maximaal 100 DATA-collectief bedrijfsnummers per request en een laatste wijzigingsdatum.
De response retourneert alleen de gewijzigde DATA-collectief bedrijfsnummers sinds de meegeleverde datum. Het request “UpdatedContacts” is analoog aan “UpdatedCompanies”, dit request retourneert een lijst van gewijzigde DATA-collectief contactpersonen nummers sinds meegegeven datum. Het gewijzigde bedrijf (Company) of Contactpersoon (Contact) kan vervolgens gedownload worden, hiervoor zal indien er geen actualisatie abonnement is 1 credit worden gerekend per bedrijf of contactpersoon. In de response komen alle velden met een timestamp terug zodat u kunt bepalen welk record er bijgewerkt wordt in uw omgeving. |
Voorbeeld flow |
Nieuwe contactpersoon aanbieden |
|
[ContactNew] Nieuwe contactpersoon aanbieden |
Heeft u voor het DATA-collectief een nog onbekende contactpersoon? Dan kunt u deze via het “ContactNew” request aan ons doorgegeven, tegen beloning van 1 credit per nieuwe contactpersoon. Dit is wel gebonden aan
een aantal criteria; de volgende gegevens van een contactpersoon moeten worden aangeboden:
Wanneer de gegevens bij een aangeboden contactpersoon niet volledig zijn ingevoerd of wanneer de aangeboden contactpersoon al bestaat bij het bewuste bedrijf, kan het u credits kosten. |
Voorbeeld flow |
Mutaties aanbieden |
|
[BaseTableMessageReasons] Eenmalig alle redenen ophalen [UserFeedbackCompany] Mutatiebericht bedrijf sturen [UserFeedbackContact] Mutatiebericht persoon sturen |
De gebruiker kan berichten aan het DATA-Collectief sturen.
Hierin kan de gebruiker bijvoorbeeld aangeven dat een adres onjuist is, zonder daarbij aan te hoeven geven wat het correcte adres is.
U kunt deze via het “UserFeedbackCompany” of “UserFeedbackContact” request aan ons doorgegeven, tegen beloning van 1 credit.
Een bedrijf of contactpersoon moet in bezit zijn wanneer u een mutatie aanbiedt, de API retourneert een foutmelding wanneer deze nog niet in bezit is.
Dit request moet worden voorzien van een reden, u kunt alle beschikbare redenen ophalen het “BaseTableMessageReasons” request. De code van een reden kan worden meegegeven aan het UserFeedback bericht. Een aangeboden mutatie wordt ook gekoppeld aan de Mijn DATA-collectief website, de gebruiker kan via de website terugvinden wat de status is van een aangeboden mutatie. |
Voorbeeld flow |
Website-Leads leads opvragen |
|
[WebsiteleadsWebsites] Eenmalig alle websites opvragen [WebsiteleadsLeads] Alle leads opvragen [ContactList] Contactpersonen zoeken [Contact] Contactpersoon downloaden |
Met het WebsiteleadsWebsites request kunnen alle geregistreerde websites waarvoor leads worden verstuurd bij het Mijn DATA-collectief account opgevraagd worden.
In de response van dit request krijgt u het veld website Name, dit veld heeft u nodig voor het WebsiteleadsLeads request. Met WebsiteleadsLeads kunnen leads uit een
gewenste periode van één website worden opgevraagd. Per call worden maximaal 250 Website-Leads geretourneerd. Wanneer het aantal op te vragen leads groter is, kies
dan een ander, korter tijdvak. In de response van dit request krijgt u de bedrijfsinformatie van de lead, bezoekersinformatie en de informatie over het klikpad. Met ContactList kunt u vervolgens alle contactpersonen bij een lead opzoeken en downloaden met het Contact request. |