Onderliggende pagina's
  • Postcode Service handleiding NL
Spring naar het einde van metadata
Ga nar het begin van metadata


Inhoudsopgave

Inleiding

Deze handleiding beschrijft de functionaliteiten van de Postcode service API en hoe u deze kunt gebruiken.

Contactgegevens TIG voor technische vragen

Wij kunnen het snelst reageren via ons ticketsysteem, stuur een e-mail naar:

servicedesk@tig.nl of gebruik deze link voor uitleg om via ons systeem een ticket aan te maken.

U kunt ook telefonisch uw vraag stelen via onze HQ in Amsterdam op 020 - 21 81 001 (directe technische ingang).

Installatie

Installatiestappen

De volgende gegevens zijn ter demo beschikbaar gesteld. Indien u uw eigen client_id en secure_code heeft ontvangen dient u deze te gebruiken. Mocht u niet in bezit zijn van deze gegevens dan kunt u deze bij TIG opvragen. Onderstaande gegevens kunnen gebruikt worden om de functionaliteit uit te proberen:

  • client_id = 1177
  • secure_code = 9SRLYBCALURPE2B

Deze gegevens bevatten wel een limiet. Zodra dit limiet bereikt is, is het nog wel mogelijk om een testaccount op te vragen. Neem contact op met TIG als u een test account wenst te ontvangen.

Versioning van de API
Aanpassingen in de TIG API gaat volgens versioning. Nieuwe functionaliteiten in de API wordt beschikbaar gemaakt volgens onze versioning URI standaard https://postcode.tig.nl/api/[versienummer]. Bij elke API wijziging wordt dit nummer verhoogd. Nieuwe wijzigingen worden waar mogelijk altijd backward compatible uitgevoerd. Wanneer een script de postcode velden in een bepaalde volgorde verwacht, of maximaal een bepaald aantal velden, zal dit in de oude versie altijd ongewijzigd blijven. Hierdoor blijft het script zonder problemen werken.

De laatste API URL versie is:
https://postcode.tig.nl/api/v3

JSON calls

De structuur van de API V3 is:

Method:		GET
Path:		/api/v3/json/getAddress/index.php?
Query parameters:

postcode = string huisnummer = number

client_id = number

secure_code = string


Response success:
Response:
{
  “success” : true,
  “straatnaam” : "Kabelweg",
  “woonplaats” : "Amsterdam"
}

Response failure:

Response:
{
  “success” : false,
  “error” : "Postcode niet gevonden"
}

Voorbeeld call van de API V3:
https://postcode.tig.nl/api/v3/json/getAddress/index.php?postcode=1014BA&huisnummer=37&client_id=1177&secure_code=9SRLYBCALURPE2B

Voorbeeld PHP-bestand

Om de postcode service in uw omgeving te integreren is hier een eenvoudig voorbeeld in PHP weergeven:

<?php
$postcode = "1014BA";
$huisnummer = 37;
$postcodeAdres =
file_get_contents("http://postcode.tig.nl/api/v3/json/getAddress/index.php?postcode=" .
$postcode . "&huisnummer=" . $huisnummer .
"&client_id=1177&secure_code=9SRLYBCALURPE2B");
						
header('Content-Type: application/json');
echo $postcodeAdres; 


Limiet aantal requests

Indien een response code 429 (429 Too Many Requests zichtbaar is in de browser) wordt teruggegeven, dan heeft u het maximaal aantal requests per seconden bereikt dat is vastgelegd in uw contract. Standaard is die 10 requests/seconden. Zodra het aantal requests weer onder het maximaal aantal limiet komt (standaard <10 requests/s) krijgt u weer de gebruikelijke responses. U kunt contact opnemen met uw accountmanager op telefoonnummer 020 - 21 81 000 indien u het aantal requests wilt uitbreiden.

Back-up
Wij adviseren u de installatie altijd eerst op een testomgeving uit te voeren en een back-up te maken van uw omgeving voor u begint.


Veelgestelde vragen

  • Is het mogelijk om meerdere servers gebruik te laten maken van de API?
    Ja, het is mogelijk om meerdere ip-addressen toe te voegen aan uw account voor eigen gebruik (zonder wederverkoop). Neem hiervoor contact op met de technische afdeling van TIG via servicedesk@tig.nl of per telefoon op 020 - 21 81 001.
  • Is het mogelijk om de database ook zelf in house te hebben en als back-up te gebruiken?
    Ja, neem hiervoor contact op met sales@tig.nl of per telefoon op 020 - 21 81 000.
  • Wat is het maximaal aantal requests dat ik naar de API kan uitvoeren?
    Dit is afhankelijk van uw contract, standaard is 10 requests / seconden. Neem telefonisch contact op met uw accountmanager op telefoonnummer 020 - 21 81 000.
  • Als ik ondersteuning nodig ehb, op welke tijdstippen kan ik TIG bereiken?
  • Het hele jaar door, 365/7/24, ook op feestdagen op telefoonnummer 020 - 21 81 001.

Technische vereisten

De postcode service heeft naast een werkende verbinding met de postcode service server geen technische vereisten. Wel is basiskennis van JSON encoding/decoding een vereiste om de service in uw omgeving te implementeren.

Zelf deze kennis niet in huis? Neem dan telefonisch contact op met onze servicedesk op 020 - 21 81 000 of stuur een e-mail naar servicedesk@tig.nl.

API Release notes

V 3.1.0

Legacy endpoint uitgebreid met postbusdata

V 2.2.0

Throttle limiting, floating IP, beschikbaarheid in regio’s US, Europa, CN

V 1.2.1

Uitgebreide terugkoppeling foutmeldingen

V 1.1.0

Publieke release, feedback verwerkt, stable version, live versie in webshops

V 1.0.5

Pilot klanten release, fine tuning

V 0.9.5

Initiële bèta release van de API dienst

Op de hoogte blijven?

U kunt zich als watcher aanmelden op deze pagina zodat u updates ontvangt bij wijzigingen.

Heeft u feedback? Wij horen het graag op 020-2181001 of per e-mail op servicedesk@tig.nl.

  • Geen labels