API: OpenSRS

OpenSRS API Guide: Domains and SSL

Welcome to the OpenSRS API guide. Here you will find comprehensive documentation regarding our domain and SSL services. We hope this guide will help you start working with OpenSRS as quickly as possible. If you have any questions or concerns, please do not hesitate to contact help@opensrs.com

Get Started

By default, a domain's admin contact is directed to the OpenSRS transfer approval URL, but a reseller can choose to instead direct clients to their own URL for approvals.

The scripts to parse the end-user replies back to OpenSRSmust pass responses through https://rr-n1-tor.opensrs.net/transfers, and must include several different actions (each of which require various fields). The required actions and fields are listed in the following tables.

Regular transfers

Key
Value

action

Confirm

domain

<domain_name>

id

<transfer_request_id>

action

whois_transfer

domain

<domain_name>

unique_id

<transfer_request_id>

action

do_confirm

domain

<domain_name>

unique_id

<transfer_request_id>

phone

phone_number

action

cancel_bulk_transfer

domain

<domain_name>

unique_id

<transfer_request_id>

Page flow

Notes:

  • The Confirm page must contain the string value='whois_transfer'.
  • The Success page must contain the string 'Thank you for confirming'.
  • The Cancel page must contain the string 'has been cancelled'.

Bulk transfers

Key
Value

action

confirm_bulk_transfer

bt

1

bulk_transfer_id

< bulk_transfer_id >

id

<transfer_request_id>

action

do_confirm_bulk_transfer

bulk_transfer_id

< bulk_transfer_id >

unique_id

<transfer_request_id>

phone

phone_number

action

cancel_bulk_transfer

domain

<domain_name>

unique_id

<transfer_request_id>

Page flow

Notes:

  • The Confirm page must contain the string 'Listed below are the domains that will be transferred:' (List of domains located between <menu>... </menu>).

  • The Success page must contain the string 'Thank you for confirming batch transfer'.

  • The Cancel page must contain the string 'has been cancelled'.

Transfers away

Key
Value

action

confirm_transfer_away

away

1

domain

<domain_name>

id

<transfer_request_id>

action

do_confirm_away

domain

<domain_name>

unique_id

<transfer_request_id>

phone

phone_number

action

do_cancel_away

domain

<domain_name>

unique_id

<transfer_request_id>

Page flow

Notes:

  • The Confirm page must contain the string 'away from' (To include time and registrar name, the page must also contain the string 'this request was entered at <date> by <registrar>').

  • The Success page must contain the string 'Thank you. Your domain will be transferred to'.

  • The Cancel page must contain the string 'Thank you. Your domain will NOT be transferred to'.

Overview