mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

Improved Name.com documentation (#231)

Browse Source 
- Improved formatting
- Other fixes
This commit is contained in:
Patrick G
2017-10-11 13:12:41 -04:00
committed by Craig Peterson
parent 8d0576ac7f
commit 208eeaac6f
1 changed files with 7 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/_providers/name.com.md
View File

@ -8,30 +8,26 @@ jsId: NAMEDOTCOM
# Name.com Provider
## Configuration
In your providers config json file you must provide your name.com api username and access token:
In your credentials file you must provide your name.com api username and access token:
{% highlight json %}
{
"name.com":{
"apikey": "yourApiKeyFromName.com-klasjdkljasdlk235235235235",
"apikey": "yourApiKeyFromName.com",
"apiuser": "yourUsername"
}
}
{% endhighlight %}
There is another key name `apiurl` but it is optional and defaults to the correct value. If you
want to use the test environment ("OT&E"), then add this:
There is another key name `apiurl` but it is optional and defaults to the correct value. If you want to use the test environment ("OT&E"), then add this:
"apiurl": "https://api.dev.name.com",
## Metadata
This provider does not recognize any special metadata fields unique to name.com.
## Usage
Example javascript (DNS hosted with name.com):
**Example Javascript (DNS hosted with name.com):**
{% highlight js %}
var REG_NAMECOM = NewRegistrar("name.com","NAMEDOTCOM");
@ -42,7 +38,8 @@ D("example.tld", REG_NAMECOM, DnsProvider(NAMECOM),
);
{%endhighlight%}
Example javascript (Registrar only. DNS hosted elsewhere):
**Example Javascript (Registrar only. DNS hosted elsewhere):**
{% highlight js %}
var REG_NAMECOM = NewRegistrar("name.com","NAMEDOTCOM");
@ -56,7 +53,4 @@ D("example.tld", REG_NAMECOM, DnsProvider(R53),
{% include alert.html text="Note: name.com does not allow control over the NS records of your zones via the api. It is not recommended to use name.com's dns provider unless it is your only dns host." %}
## Activation
In order to activate api functionality on your name.com account, you must apply to the api program.
The application form is [located here](https://www.name.com/reseller/apply). It usually takes a few days to get a response.
After you are accepted, you should receive your api token via email.
In order to activate API functionality on your Name.com account, you must apply to the API program. The application form is [located here](https://www.name.com/reseller/apply). It usually takes a few days to get a response. After you are accepted, you should receive your API token via email.