Spikkl NodeJS Module

Spikkl NodeJS module

De NodeJS module is een makkelijke manier om de Spikkl Postcode API toe te voegen aan jouw NodeJS project. Die hebben we speciaal ontwikkeld om er voor te zorgen dat je niet hoeft te werken met de kale API. Het enige wat je hoeft te doen is de module te installeren en een API key toe te voegen. Bovendien zijn de eerste 100 requests per maand gratis!

                            
$ npm install @spikkl/spikkl-js-node-client --save
                            
                        

                            
$ yarn add @spikkl/spikkl-js-node-client
                            
                        

                            
// Importeer de Spikkl API Client (CommonJS)
const { createSpikklClient } = require('@spikkl/spikkl-js-node-client');

const spikklClient = createSpikklClient({ apiKey: 'API_KEY' });
                            
                        

                            
// Importeer de Spikkl API Client (Javascript Modules)
import createSpikklClient from '@spikkl/spikkl-js-node-client';

const spikklClient = createSpikklClient({ apiKey: 'API_KEY' });
                            
                        

Aan de slag

Je kunt de Spikkl NodeJS module installeren met NPM, Yarn of je download de package om de module handmatig toe te voegen. Importeer de module via de CommonJS specificatie of via Javascript modules. Beide geven een functie waarmee je de Spikkl client kan oproepen en kan gebruiken voor het opzoeken van adressen via postcode of coördinaten.

modules.node_js.install_instruction_two

Gebruik

Er zijn momenteel twee functies beschikbaar bij de Spikkl client: lookup en reverse. De lookup functie zoekt het adres bij een postcode-huisnummer combinatie en geeft een JSON object terug. De reverse functie zoekt een adres (of meerdere adressen) aan de hand van een coördinaat, ook deze functie geeft een JSON object terug met data.

                            
spikklClient.lookup({
    postalCode: '2611HB',
    streetNumber: '175'
})
    .then( result => {
        // Gebruik het adres
    })
    .catch( error => {
        // Handel de fout af
    });
                            
                        

                            
spikklClient.reverse({
    longitude: '4.354901',
    latitude: '52.012133'
})
    .then( result => {
        // Gebruik het adres of de adressen
    })
    .catch( error => {
        // Handel de fout af
    });