Skip to content

Configuration

Jump to bottom
Colin Campbell edited this page Sep 23, 2015 · 4 revisions

Configuration Options

OSRS_HOST

  • LIVE: rr-n1-tor.opensrs.net
  • TEST: horizon.opensrs.net

CRYPT_TYPE

OpenSRS default encryption type

  • ssl (default)
  • sslv3
  • tls

Please note that OpenSSL ver 1.0.1e does not work with "ssl" cryption type

OSRS_USERNAME

OpenSRS Reseller Username

OSRS_KEY

OpenSRS Private Key To generate a key, login into the RWI by going to the following address,

In RWI, Profile Management > Generate New Private Key

OSRS_DEBUG

WHen set to 1, the Toolkit will spit out the raw XML request/response.

MAIL_HOST

MAIL_USERNAME

Company level email admin username

MAIL_PASSWORD

Company level email admin password

MAIL_ENV

Mail environment - LIVE or TEST

Generating Private Key

To generate a key, login into the RWI by going to the following address:

LIVE:  https://rr-n1-tor.opensrs.net/resellers/
TEST:  https://horizon.opensrs.net/resellers/

NOTE: The TEST system is rather different than the LIVE system. Therefore, during testing, the results that you receive are VERY different than you would get on the LIVE system. Both Personal Names and Domain searching will yield different results.

Once authenticated, scroll down to the bottom of the page where the heading shows "Profile Management". Here, there is a link called "Generate New Private Key". If you are sure you wish to continue, click on the 'OK' button on the warning window. This window ensure that you wish to generate a new key. On refresh, you will see a key similar to this structure:

a2e308f4df69c969de9ada09c39bb43d0e4d0a88ce83fd2c0a193328d16e8bf5080ee7e0ef388fd8aa0dfb42d33dcd02d3de321c9af1f06b

This is essentially the authentication key that you'll be using to working with the API. It's essential to keep this key to yourself!

Whitelisting IP address

Once you've generated your key (as above), you'll also need to whitelist your IP address. If this is not done, an error will be received and continuing with the API will not possible. To whitelist your IP address, login to either LIVE or TEST environment in the RWI (like in section 2.1.0). Scroll down to the bottom of the screen under the "Profile Management" section, there is a link called "Add IPs for Script/API Access". Once you've clicked on that, you can "Add New Rule" by typing in the subnet for where your application will be hosted. A total of 5 addresses can be added by default.

IMPORTANT NOTE: Adding a new IP address can take up to 15 minutes to propagate into our system.

Clone this wiki locally