domrobot-client
v3.2.2
Published
INWX Domrobot Node.JS Client
Downloads
5,038
Maintainers
Readme
INWX Domrobot Node.js Client
You can access all functions of our frontend via our API, which is available via the JSON-RPC protocol and thus can be easily consumed with all programming languages.
There is also an OT&E test system, which you can access via ote.inwx.com. Here you will find the known web interface which is using a test database. On the OT&E system no actions will be charged. So you can test as much as you like there.
Documentation
You can view a detailed description of the API functions in our documentation. You can find the online documentation by clicking here.
If you still experience any kind of problems don't hesitate to contact our support via email.
Installation
The recommended way is via npm:
npm install --save domrobot-client
You can find more information about the package on npmjs.org.
Example
import { ApiClient, Language } from 'domrobot-client';
const username = '';
const password = '';
const sharedSecret = ''; // only needed for 2FA.
const domain = 'my-test-domain-' + Math.round(Math.random() * 1e8) + '.com'; // the domain which will be checked.
const asyncFunc = async () => {
// By default your ApiClient uses the test api (OT&E). If you want to use the production/live api
// we have a constant named API_URL_LIVE in the ApiClient class. Just set apiUrl=ApiClient.API_URL_LIVE and you're good.
const apiClient = new ApiClient(ApiClient.API_URL_OTE, Language.EN, true);
const loginResponse = await apiClient.login(username, password, sharedSecret);
if (loginResponse.code !== 1000) {
throw new Error(`Api login error. Code: ${loginResponse.code} Message: ${loginResponse.msg}`);
}
// Make an api call and save the result in a variable.
// We want to check if a domain is available, so we call the api method 'domain.check'.
const domainCheckResponse = await apiClient.callApi('domain.check', { domain });
if (domainCheckResponse.code !== 1000) {
throw new Error(`Api error while checking domain status. Code:
${domainCheckResponse.code} Message: ${domainCheckResponse.msg}`);
}
// get the first domain in the result array 'domain'
const checkedDomain = domainCheckResponse.resData.domain[0];
if (checkedDomain.avail === 1) {
console.log(`${domain} is still available!`);
} else if (checkedDomain.avail === -1) {
console.log(`Availability of ${domain} could not be checked.`);
} else {
console.log(`Unfortunately, ${domain} is already registered.`);
}
};
// call the async function
asyncFunc();
License
MIT