An application program interface (API) is a set of routines, protocols, and tools for building software applications. An API specifies how software components interact. By assembling a string of components, you can complete tasks without logging in to your account directly. This article explains how Enom API calls are structured and how to read the responses they return.
How the Enom API works
The API is available for Enom reseller accounts only. It lets you check on domains and services without logging in to your reseller account directly. Currently, there are no bulk options for the API, so each action affects a single service or domain. Before you can use the API, you must whitelist your IP addresses.
Before you begin
- Confirm you have an active Enom reseller account.
- Set up your test API environment so you can run test commands before working in the live environment.
- Whitelist the static IP address from which you will run API commands.
- Have your login ID and password or API token ready.
Step 1: Build the API call
Once your test API environment is set up, you can run test API commands in the test environment and live API commands in the live environment. Each API command has parameters that must be met. When working in the live environment, ensure your call reflects a live call and not a test.
To return the desired results, include all parameters listed as required. The standard parts of the call you always input are:
| command | Command name. |
| sld | The second-level domain (replace with the domain you want). |
| tld | The top-level domain (com, net, info, biz, etc.). |
| uid | Username/Login ID. |
| pw | Password or your token. |
| responsetype | How you want to see the results (XML, HTML, or Text). |
Note: All activity performed in your test account does not affect your live account. Similarly, any domains registered or services purchased in your test account are not automatically provisioned.
A call should look like this:
https://resellertest.enom.com/interface.asp?command=check&sld=1plus1&tld=tv&uid=resellid&pw=resellpw&responsetype=xmlStep 2: Read the response
Once you have created the call, copy and paste it into the URL bar in a new tab and press Enter to get your response.
A successful call provides you with the details for the call. An unsuccessful call returns errors specific to the issue.
If you run the check command shown above, you receive the following positive response.
Step 3: Interpret errors
When you run an unsuccessful call, the response provides the errors and the error count. In this GetBalance call, the response provides the error. Many API error codes can be presented.
You can reach out to support if you need assistance with the error. Have the command and response ready for us to review.
Next steps
Questions? Contact Enom Support.
How helpful was this article?
Thanks for your feedback!
Do you still need help? If so please submit a request here.