From 39c6df299caa7aad0b3fef1fc951cf930f1fc140 Mon Sep 17 00:00:00 2001
From: neil <git@byneil.com>
Date: Sun, 7 Feb 2016 18:29:28 +0800
Subject: [PATCH] readme for using api

---
 README.md        | 12 +++----
 dnsapi/README.md | 86 ++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 92 insertions(+), 6 deletions(-)
 create mode 100644 dnsapi/README.md

diff --git a/README.md b/README.md
index 497dce3e..bc0d133b 100644
--- a/README.md
+++ b/README.md
@@ -165,17 +165,17 @@ Ok, it's finished.
 
 #Automatic dns api integeration
 
-If your dns provider support api access,  we can use api to automatically issue certs.
+If your dns provider supports api access,  we can use api to automatically issue certs.
 You don't have do anything manually.
 
-Current we support:
-## Cloudflare.com  api
-## Dnspod.cn  api
-## Cloudxns.com  api
+Currently we support:
+1. Cloudflare.com  api
+2. Dnspod.cn  api
+3. Cloudxns.com  api
 
 More apis are comming soon....
 
-##If your dns provider is not in the supported list above, you write your own script api easily.
+If your dns provider is not in the supported list above, you can write your own script api easily.
 
 For more details: [How to use dns api](/Neilpang/le/blob/master/dnsapi/README.md)
 
diff --git a/dnsapi/README.md b/dnsapi/README.md
new file mode 100644
index 00000000..005b8434
--- /dev/null
+++ b/dnsapi/README.md
@@ -0,0 +1,86 @@
+# How to use dns api
+
+## Use CloudFlare domain api to automatically issue cert
+
+For now, we support clourflare integeration.
+
+First you need to login to your clourflare account to get your api key.
+
+```
+export CF_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
+
+export CF_Email="xxxx@sss.com"
+
+```
+
+Ok, let's issue cert now:
+```
+le.sh   issue   dns-cf   aa.com  www.aa.com
+```
+
+The `CF_Key` and `CF_Email`  will be saved in `~/.le/account.conf`, when next time you use cloudflare api, it will reuse this key.
+
+
+
+## Use Dnspod.cn domain api to automatically issue cert
+
+For now, we support dnspod.cn integeration.
+
+First you need to login to your dnspod.cn account to get your api key and key id.
+
+```
+export DP_Id="1234"
+
+export DP_Key="sADDsdasdgdsf"
+
+```
+
+Ok, let's issue cert now:
+```
+le.sh   issue   dns-dp   aa.com  www.aa.com
+```
+
+The `DP_Id` and `DP_Key`  will be saved in `~/.le/account.conf`, when next time you use dnspod.cn api, it will reuse this key.
+
+
+## Use Cloudxns.com domain api to automatically issue cert
+
+For now, we support Cloudxns.com integeration.
+
+First you need to login to your Cloudxns.com account to get your api key and key secret.
+
+```
+export CX_Key="1234"
+
+export CX_Api="sADDsdasdgdsf"
+
+```
+
+Ok, let's issue cert now:
+```
+le.sh   issue   dns-cx   aa.com  www.aa.com
+```
+
+The `CX_Key` and `CX_Api`  will be saved in `~/.le/account.conf`, when next time you use Cloudxns.com api, it will reuse this key.
+
+
+
+# Use custom api
+
+If your api is not supported yet,  you can write your own dns api.
+
+Let's assume you want to name it 'myapi',
+
+1. Create a bash script named  `~/.le/dns-myapi.sh`,
+2. In the scrypt, you must have a function named `dns-myapi-add()`. Which will be called by le.sh to add dns records.
+3. Then you can use your api to issue cert like:
+
+```
+le.sh  issue  dns-myapi  aa.com  www.aa.com
+```
+
+For more details, please check our sample script: [dnsapi/dns-myapi.sh](README.md)
+
+
+
+