Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
tag: v0.3.4
Fetching contributors…

Cannot retrieve contributors at this time

63 lines (40 sloc) 2.759 kb

TransIP API

Ruby gem to use the full TransIP API (v4.2). Uses an updated version of savon, and implements the new request signing method that the guys at TransIP have introduced into their api. So far, i have only tested the :get_domain_names, :get_info and :set_dns_entries calls.

The transip API makes use of public/private key encryption. You need to use the TransIP control panel to give your server access to the api, and to generate a key. You can then use the key together with your username to gain access to the api

For more info see:

Credits for full rewrite to work with new TransIP API version go to Richard Bronkhorst (github.com/richmans).

Install

Install from rubygems (rubygems.org/gems/transip):

gem install transip

or add in your Bundle Gemfile:

gem 'transip'

For the latest version: Download / clone the repository. Bundle install the needed gems and require the lib.

git clone git://github.com/joost/transip.git
cd transip
bundle install
irb # and require './lib/transip'

API Credentials

Enable the TransIP API via www.transip.nl/cp/mijn-account/#api. Make sure:

  • you enable the API

  • add your IP to the access list

  • create and save your RSA private key

Usage

For the most up-to-date documentation see the source files.

Setup the API client:

# use this in production
transip = Transip.new(username: 'your_username', key: 'your_private_rsa_key', ip: '12.34.12.3', mode: :readwrite)

In development you can leave out the ip. To test request use :readonly mode.

transip.actions #  => [:batch_check_availability, :check_availability, :get_whois, :get_domain_names, :get_info, :batch_get_info, :get_auth_code, :get_is_locked, :register, :cancel, :transfer_with_owner_change, :transfer_without_owner_change, :set_nameservers, :set_lock, :unset_lock, :set_dns_entries, :set_owner, :set_contacts, :get_all_tld_infos, :get_tld_info, :get_current_domain_action, :retry_current_domain_action_with_new_data, :retry_transfer_with_different_auth_code, :cancel_domain_action]

transip.request(:get_domain_names)
transip.request(:get_info, :domain_name => 'example.com')
transip.request(:get_whois, :domain_name => 'example.com')
transip.request(:set_dns_entries, :domain_name => 'example.com', :dns_entries => [Transip::DnsEntry.new('test', 5.inutes, 'A', '74.125.77.147')])
transip.request(:register, Transip::Domain.new('example.com', nil, nil, [Transip::DnsEntry.new('test', 5.minutes, 'A', '74.125.77.147')]))

Please feel free to contribute and send me a pull request via Github!

Copyright © 2013 Richard Bronkhorst, released under the MIT license

Jump to Line
Something went wrong with that request. Please try again.