API Keys

Registering for an API Key

API keys are not required at this stage, but they are in place to help with trouble shooting and monitoring usage of the web service.

To obtain an API Key please get in touch with the NZOR team at the email address on the following web page.


Using an API Key

Add the API Key to the X-Api-Key header for each request.


curl -X GET http://data.nzor.org.nz/v1/names/438cd203-0c57-46e7-829a-be2c9549cd94 -H "X-Api-Key: the-key"