github.com/pmoroney/dnscontrol@v0.2.4-0.20171024134423-fad98f73f44a/docs/_providers/namecheap.md (about)

     1  ---
     2  name: Namecheap Provider
     3  layout: default
     4  jsId: NAMECHEAP
     5  ---
     6  
     7  # Namecheap Provider
     8  
     9  ## Configuration
    10  
    11  In your providers config json file you must provide your Namecheap api
    12  username and key:
    13  
    14  {% highlight json %}
    15  {
    16    "namecheap":{
    17      "apikey": "yourApiKeyFromNameCheap",
    18      "apiuser": "yourUsername"
    19    }
    20  }
    21  {% endhighlight %}
    22  
    23  You can optionally specify BaseURL to use a different endpoint - typically the
    24  sandbox:
    25  
    26  {% highlight json %}
    27  {
    28    "namecheap.com":{
    29      "apikey": "yourApiKeyFromNameCheap",
    30      "apiuser": "yourUsername"
    31      "BaseURL": "https://api.sandbox.namecheap.com/xml.response"
    32    }
    33  }
    34  {% endhighlight %}
    35  
    36  if BaseURL is omitted, the production namecheap url is used.
    37  
    38  
    39  ## Metadata
    40  
    41  This provider does not recognize any special metadata fields unique to
    42  Namecheap.
    43  
    44  ## Usage
    45  
    46  Example javascript:
    47  
    48  {% highlight js %}
    49  var REG_NAMECHEAP = NewRegistrar("namecheap","NAMECHEAP");
    50  var R53 = NewDnsProvider("r53", "ROUTE53");
    51  
    52  D("example.tld", REG_NAMECHEAP, DnsProvider(R53),
    53      A("test","1.2.3.4")
    54  );
    55  {%endhighlight%}
    56  
    57  Namecheap provides custom redirect records URL, URL301, and FRAME.  These
    58  records can be used like any other record:
    59  
    60  {% highlight js %}
    61  var REG_NAMECHEAP = NewRegistrar("namecheap","NAMECHEAP");
    62  var NAMECHEAP = NewDnsProvider("namecheap","NAMECHEAP");
    63  
    64  D("example.tld", REG_NAMECHEAP, DnsProvider(NAMECHEAP),
    65    URL('@', 'http://example.com/'),
    66    URL('www', 'http://example.com/'),
    67    URL301('backup', 'http://backup.example.com/')
    68  )
    69  {% endhighlight %}
    70  
    71  ## Activation
    72  
    73  In order to activate api functionality on your Namecheap account, you must
    74  enable it for your account and wait for their review process. More information
    75  on enabling API access is [located
    76  here](https://www.namecheap.com/support/api/intro.aspx).