API Module Domain suggestNameDomainRequest

From Openprovider API documentation

(Difference between revisions)

Revision as of 07:22, 11 May 2021

Module Domain > Name Suggestion

Module	domain
Command name	suggestNameDomainRequest
Use	Returns a list of domain suggestions based on a search term
Input	name - the search term which will be used to generating matches limit - maximum number of suggestions to return language - the 3 letter country code for the desired search language (ISO-3166 ALPHA-3 code format) sensitive - 1 to remove domain name suggestions deemed obscene by the supplier. 0 to include obscene domain name suggestions.
Output	returns array of domain suggestions with the following format: name (domain and TLD seperated by '.') domain (domain name, not including the tld) tld (only the tld )

Examples

Using PHP class

$request = new OP_Request;
$request->setCommand('suggestNameDomainRequest')
 ->setAuth(array('username' => 'username', 'password' => 'password'))
 ->setArgs(array(
   'name' => 'wac', //search term 
   'limit'  => 3,
   'language' => 'spa',
   'sensitive' => 1,
 ));

Raw XML

Please note that newlines and leading spaces are added only for readability. Those whitespaces should be excluded from your XML command before sending it to Openprovider.

<?xml version="1.0" encoding="UTF-8"?>
<openXML>
  <credentials>
    <username>username</username>
    <password>password</password>
  </credentials>
  <suggestNameDomainRequest>
    <name>wac</name>
    <limit>3</limit>
    <language>spa</language>
    <sensitive>1</sensitive>
    <tlds>
      <array>
        <item>com</item>
        <item>info</item>
        <item>com.es</item>
      </array>
    </tlds>
  </suggestNameDomainRequest>
</openXML>

<?xml version="1.0" encoding="UTF-8"?>"
<openXML>
  <reply>
  0
<desc></desc>
<data>
  <array>
    <item>
      <name>SheWac.com</name>
      <domain>SheWac</domain>
      <tld>com</tld>
    </item>
    <item>
      <name>HeWac.info</name>
      <domain>HeWac</domain>
      <tld>info</tld>
    </item>
    <item>
      <name>HeWac.com.es</name>
      <domain>HeWac</domain>
      <tld>com.es</tld>
    </item>
  </array>
</data>
</reply>
</openXML>

@@ Line 13: / Line 13: @@
 |'''Input'''
 |
-*name - the search term for to match to
+*name - the search term which will be used to generating matches
-*limit
+*limit - maximum number of suggestions to return
-*language
+*language - the 3 letter country code for the desired search language (ISO-3166 ALPHA-3 code format)
-*sensitive
+*sensitive - 1 to remove domain name suggestions deemed obscene by the supplier. 0 to include obscene domain name suggestions.
 |- style="vertical-align:top;"
 |'''Output'''