Helemaal de weg kwijt?

Authentication

API Key

Using the Spikkl API requires a valid API key. The API key is a unique identifier that is used to authenticate requests for usage and billing purposes. The API key must pass with each call to the API as the value of the key parameter.

Get tha API key

You must have at least one API key associated with your application. One API key is generated after your signed up for an account. To get a another API key, follow the following steps:

• Login to your account.
• Click the account dropdown, right in the header bar, and choose credentials.
• On the credentials page, click Create credentials.
• A new API key is listed on the credentials page.

You can edit the name of your API key or restrict the usage of the API key.

Add the API key to the request

You must include an API key with every Spikkl Geo API request. In the example, replace API_KEY with your freshly generated API key.

https://api.spikkl.nl/geo/nld/lookup.json?key=API_KEY&postal_code=2611KL&street_number=15

Restrict your API key

We strongly recommend that you restrict you APi key. Restrictions provide added security and ensure the API key can be used by you only. Currently, Spikkl provided application restrictions with limited usage to either websites (HTTP referrers) and web servers (IP addresses). To restrict your API keys:

• Login to your account.
• Click the account dropdown, right in the header bar, and choose credentials.
• Select the API key you like to restrict and click the edit button.
• Down the page, you can set restrictions using a referrer or IP address.

You can add multiple ip addresses or referrers, separated with comma's.

Rate limit

The Spikkl API usage a rate limiting mechanism to keep the service available for all users. Free trial users are limited to 5 requests per second, paying customers can use the service ranging from 10 to 15 requests per second, depending on the subscription type. Exceeding the rate limit may cause a temporary block.