Spikkl PHP Laravel Module

Spikkl PHP Laravel Module

Om Spikkl makkelijk aan jouw PHP Laravel project te kunnen toevoegen hebben we een aparte module ontwikkeld die er voor zorgt 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!

                            
$ composer require spikkl/spikkl-php-laravel-client:^1.0
                            
                        

                            
# Voeg de Spikkl API key toe aan je environment file.
SPIKKL_API_KEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
                            
                        

                            
// Een HTTP request uitvoeren naar de API
// op basis van een postcode en huisnummer.
$results = Spikkl::api()->lookup('nld', '2611HB', '175', null);

// Je kan ook een helper gebruiken
// om toegang te krijgen tot de Spikkl instance.
$results = spikkl()->lookup('nld', '2611HB', '175', null);

// Een HTTP request uitvoeren naar de Spikkl
// API op basis van coordinaten (latitude en longitude).
$results = Spikkl::api()->reverse('nld', 52.012133, 4.354901);
                            
                        

Aan de slag

Voeg de Spikkl PHP Laravel module toe aan je composer bestand. Met Laravel wordt de Spikkl service provider automatisch toegevoegd met de auto-discovery functionaliteit van Laravel. Met Lumen moet je de Service Provider en Facade zelf toevoegen.

Hierna voeg je als laatste stap de API key toe aan het environment bestand. De client is nu beschikbaar via een Helper of de Spikkl Facade.

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 Laravel module gebruikt specifieke excepties om aan te geven wat er precies fout is gegaan. Deze foutmeldingen zijn afkomstig van de Spikkl PHP module.

                            
try {
   $results = Spikkl::api()->lookup('nld', '2611HB', '175', null);
} catch (\Spikkl\Api\Exceptions\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.
}