Certifying Your API Reseller Account to Connect to the Production Environment
Before you can connect to the API production environment, you must complete a certification to demonstrate competence with a series of API core requests. Once you complete the certification, we email you further instructions.
If you have not already done so, complete the steps in these articles before attempting the certification:
- Setting Your API Reseller Operational Test Environment Password
- Connecting to the API Reseller Operational Test Environment
To Enable the API's Certification Mode
- Go to HostingDude Account LOGIN, and then log in to your account.
- From the Reseller Settings section, click Certification Status.
- Select Check the box for certification mode and press Apply, and then click Apply.
Your API account enters certification mode. With this setting, the Operational Test Environment (OTE) API can evaluate your requests against its certification scripts.
To Complete the Certification
Connect to the OTE API. For more information, see Connecting to the Reseller API Production Environment.
To complete the certification you must complete the tasks detailed below in the order presented. The API tracks your progress, and failure to complete the tasks in order displays the error message "Requested node(s) not matched."
Domain Name Availability Check
Instructions:: Use the CheckAvailability()
method to verify the availability of the domain name "example.biz" and "example.us".
Result: The API response XML should indicate that both domain names are available.
Domain Name Registration
Instructions: Use the OrderDomains()
method to register the domain names "example.us" and "example.biz" for two years under a new shopper account, with password "abcde."
Result: The API response XML should indicate that both domains successfully registered.
Additional Information:
- Product IDs
- 2-year .US domain name registration — 350127
- 2-year .BIZ domain name registration — 350077
- Name Servers
- ns1.example.com
- ns2.example.com
- Registrant Data
- First name — Artemus
- Last name — Gordon
- Email — agordon@wildwestdomains.com
- Address — 2 N. Main St.
- City — Valdosta
- State — Georgia
- Phone — (888) 555—1212
- ZIP — 17123
- Country — United States
- Other Data
- Assume a U.S. citizen living in the U.S. purchased the .US domain name for personal use.
- Use the cases in the examples above for all values entered. For example, the API does not process State values if you use all capital letters.
- The API does not process XML containing ASCII characters.
- The WAPI web service defines information using the Nexus object.
- The product ID values are also in the Product IDs addendum, available for download from the Reseller Extranet.
- Assume the shopper agreed to the Order Terms of Service:
<acceptOrderTOS>agree</acceptOrderTOS>
The API response XML contains the new user's ID. Note this ID for use in the Domain Name Privacy Purchase step.
Domain Name Privacy Purchase
Instructions: Use the Poll()
method to obtain the resource id of example.biz, and then use the
OrderDomainPrivacy()
method to add privacy to the domain name "example.biz" purchased in the previous step.
Create a new privacy account with password "defgh" and email address "info@example.biz" to manage the information.
Domains By Proxy®, a WWD sister company, manages private registrations.
Result: The API response XML should indicate that the private registration was successfully added.
Additional Information:
- Product ID
- Private registration — 377001
- User
- The API created and returned a unique identifier during the Domain Name Registration step. Provide this value so that the API can create a relationship between the domain shopper and the Domains By Proxy account when adding privacy to the domain.
- Assume the shopper agreed to the Order Terms of Service:
<acceptOrderTOS>agree</acceptOrderTOS>
- Domain Resource ID
- The Domain Resource ID is retrieved through the
Poll(...)
method. Save the API's response XML from this step for use in the Domain Name Information Query step.
- The Domain Resource ID is retrieved through the
WARNING: After responding to a poll request, the Web Service deletes any messages from the API message queue. You are responsible to save any data that you might need for future management requests.
Domain Name Availability Check
Instructions: Check the availability of domain name "example.biz".
Result: The API response XML should indicate that neither domain can be registered (having been registered earlier in the certification process).
Domain Name Information Query
Instructions: Use the Info()
method to query information about the domain name "example.biz", and then pass the resource ID of example.biz.
Result: The API response XML should indicate the domain name, creation date, owner ID, expiration date, and status.
Domain Name Renewal
Instructions: Use the OrderPrivateDomainRenewals()
method to renew the domain names "example.us" and "example.biz" for one additional year. Because privacy has been added to "example.biz", you must renew this resource, as well.
Result: The API response XML should indicate that boths domains and one privacy account successfully renewed.
Additional Information
- Product IDs
- .US 1-year domain name renewal — 350137
- .BIZ 1-year domain name renewal — 350087
- Privacy 1-year renewal — 387001
- User
- The API response XML identified a unique user ID during the Domain Registration step.
- Assume the shopper agreed to the Order Terms of Service:
<acceptOrderTOS>agree</acceptOrderTOS>
- Resource IDs
- The
Poll()
method retrieve both domain's resource IDs. Retrieve the DBP resource ID with a newPoll()
method call. This returns information from the domain name privacy order from the Domain Name Privacy Purchase task.
- The
Domain Name Transfer
Instructions: Use the OrderDomainTransfer()
method to transfer the domain "example.com" to a new Wild West® Domains shopper account.
Result: The API response XML should indicate that the order successfully processed.
Additional Information
- Name Servers
- ns1.example.net, ns2.example.net
- Product ID
- .COM Transfer — 350011
- Registrant Data
- First Name — Joe
- Last Name — Smith
- Email — joe@smith.us
- Address — 1 S. Main St.
- City — Oakland
- State — California
- ZIP — 97123
- Country — United States
- Phone — (777)555-1212
- Password — "ghijk"
- User
- Assume the shopper agreed to the Order Terms of Service:
<acceptOrderTOS>agree</acceptOrderTOS>
- Assume the shopper agreed to the Order Terms of Service:
Once you complete the Domain Name Transfer task, you receive a certification completion confirmation email. You can now access the production Reseller Extranet and API environments using your Shopper ID and the API password you created using Setting Your API Reseller Operational Test Environment Password.
You cannot repeat tasks within the same certification. If you need to restart the certification, call the ProcessRequest(...)
method and use the script element of the manage request. The following code snippet shows an example:
sCLTRID = System.Guid.NewGuid().ToString(); WsWWDAPI.WAPI wapi = new WsWWDAPI.WAPI();
sReturnXml = wapi.ProcessRequest("<wapi clTRID='" + sCLTRID + "' account='MarkAPI' pwd='password'><manage><script cmd='reset' /></manage></wapi>");