github.com/philhug/dnscontrol@v0.2.4-0.20180625181521-921fa9849001/docs/_providers/namecheap.md (about)

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