Spikkl PHP Module

Spikkl PHP module

Voor jouw gemak hebben we een module ontwikkeld waarmee je Spikkl makkelijk kan toevoegen aan je eigen PHP applicatie. Je hoeft dus niet meer aan de slag met de kale API. Het enige wat je hoeft te doen is de module te installeren en de API key toe te voegen. Bovendien zijn de eerste 100 requests per maand gratis!

                            
$ composer require spikkl/spikkl-php-client:^1.2
                            
                        

                            
$spikkl = new \Spikkl\Api\ApiClient();
$spikkl->setApiKey("API_KEY");

// Een HTTP request uitvoeren naar de API
// op basis van een postcode en huisnummer.
$results = $spikkl->lookup("NLD", "2611HB", "175");

// Een HTTP request uitvoeren naar de Spikkl
// API op basis van coordinaten (latitude en longitude).
$results = $spikkl->reverse("NLD", 4.899431, 52.379189);
                            
                        

Aan de slag

Als je composer gebruikt voor je PHP applicatie kun je "spikkl/spikkl-php-client" toevoegen aan je composer.json bestand. Je kan de PHP module ook handmatig toevoegen en de bestanden downloaden.

Eenmaal toegevoegd kun je je client initialiseren en de API key toevoegen. Nu kun je adressen opvragen met een request naar de Spikkl Postcode API. Dit kan met een postcode + huisnummer combinatie, maar zelfs ook met een coördinaat.

Foutafhandeling

Spikkl gebruikt de gebruikelijke HTTP response codes om aan te geven of een request is gelukt of niet. Wanneer een code in de 200 range zit, is de request succesvol. Wanneer een code in de 400 range zit, is de request niet succesvol. De Spikkl PHP module gebruikt specifieke excepties om aan te geven wat er precies fout is gegaan

                            
use Spikkl\Api\Exceptions\AccessRestrictedException;

try {
    $results = $spikkl->lookup("NLD", "2611HB", "175");
} catch (AccessRestrictedException $exception) {
    // De API key is beperkt tot een bepaald IP adres of website.
} catch (\Spikkl\Api\Exceptions\InvalidApiKeyException $exception) {
    // De API key is niet juist.
} catch (\Spikkl\Api\Exceptions\RevokedApiKeyException $exception) {
    // De API key is ingetrokken en kan niet gebruikt worden.
} catch (\Spikkl\Api\Exceptions\ZeroResultsException $exception) {
    // De request is succesvol, maar er API kan geen
    // resultaten vinden die voldoen aan de meegestuurde waarden.
} catch (\Spikkl\Api\Exceptions\QuotaReachedException $exception) {
    // Je bent over je abonnement heen en kan niet meer
    // gebruik maken van de API, tot aan de volgende maand.
} catch (\Spikkl\Api\Exceptions\InvalidRequestException $exception) {
    // Een van de meegestuurde waarden (postcode, huisnummer of toevoeging)
    // is niet juist.
}