Simple and fast authenticating API wrapper for the New Zealand Companies Office. Full functionality to search by company name, company number and director. Further functionality can be easily exposed inline with API documentation.
The New Zealand Companies Office has an API which can be accessed through registration at: http://www.business.govt.nz/businessdata
Registration is required in order to obtain unique access keys to use the API.
Add this line to your application's Gemfile:
gem 'nzcoapi'And then execute:
$ bundle
Or install it yourself as:
$ gem install nzcoapi
Figaro is a dependency required to securely store your Companies Office access and secret keys.
Execute the following to setup application.yml to store your Companies Office keys with Figaro.
$ rails generate nzcoapi:install
Alternatively you can manually add your Companies Office keys:
# config/application.yml
$ nzcoapi_access_key: "J5zFrdbg2iw"
$ nzcoapi_secret_key: "fin39USzsZGWgL2yUDQ1C0n6NBtv2"
Three functions have been exposed, as per below.
$ NZcoapi.find_company(123566)
Full company details based on a unique 'Company Number' will be returned.
$ NZcoapi.find_director("Jones, Bob")
All company directorships (active and inactive) of this individual will be returned.
$ NZcoapi.search_for_company("TradeMe")
Search results for this company name will be returned.
All output is returned as parsed XML. Within a rails view it can be quickly navigated with Nokogiri, for example:
# In View
<%= NZcoapi.find_company(973228).css('companyName').text %>
# Returns
Trade Me Limited
NB: This Gem is not developed or maintained by the New Zealand Companies Office in anyway.
Please don't hesitate to get in touch if you have any queries and I'll try and point you in the right direction!
- Fork it ( https://github.com/[my-github-username]/nzcoapi/fork )
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes (
git commit -am 'Add some feature') - Push to the branch (
git push origin my-new-feature) - Create a new Pull Request