internetee/registry

BSA gateway integration

Opened this issue · 0 comments

vohmar commented

Create new reserved domains list for BSA protected domains. The table need multiple columns:

  • Order id
  • Suborder id
  • Domain name (FQDN Punycode)
  • State
  • registration code (if domain name is simultaneously in the reserved, auction or disputed list the registration code needs to match in each of those lists for the domain name)
  • create date
  • update date

Restful JSON API request to BSA (api.bsagateway.co)
all api requests except login require bearer token from the login. Token is valid for 30 minutes and there can be only one active token per user - new login creates new token and expires the old one if there were any still active.

regular queries to BSA API to update the list of BSA protected domains

all orders need to be saved in the BSA list and removed only when they are removed from BSA system (status: Queued for Release)

Once a day we need to send a domain report of unavailable domains back to BSA in zipped format together with file checksum. API - POST method

Domain names in the BSA reserved list can be simultaneously in other blocked and reserved lists or be registered

Operations:

  • Retrieve List of all Orders (GET)
  • View Order (GET)
  • Marking Suborders (POST)
  • Add to nonblockednames List Per Suborder (POST)
  • Add to nonblockednames List For All Related Suborders (POST)
  • Remove from nonblockednames List Per Suborder (POST)
  • Remove from nonblockednames List For All Related Suborders (POST)
  • Mark Suborder as Completed (Active)
  • Download Nonblockednames List (GET)
  • Queued For Release to Release In Progress
  • Release In Progress to Closed
  • Upload Unavailable Domains Report (POST)

For whois records blocked and disputed lists take priority - record is generated after those lists
If domain name in BSA list is not registered nor is it in blocked or disputed list whois record is created with message

Domain Name: domain-name.example
>>> This name is not available for registration.
>>> This name has been blocked by a GlobalBlock service.
>>> Last update of WHOIS database: 2023-01-19T23:16:30Z <<<