Initial Home page

master
Vladislavs Dovoreckis 2018-06-23 22:24:36 +03:00
commit f91332822d
1 changed files with 147 additions and 0 deletions

147
Home.md Normal file

@ -0,0 +1,147 @@
Welcome to the api wiki!
<!--TAB ONE:begin-->
<div id="tab-2" class="tab-content ">
<div class="content-box">
<div class="flex-two-col">
<div class="detail-block db-left txt-block">
<h3 class="ico-resell"><?php echo('Changelog')?></h3>
<h6>"unique_code" added for Comodo</h6>
<p>We have added "unique_code" field for "addSSLOrder" and "reIssueSSLOrder". The code required for all Comodo orders.</p>
<p>You must send Unique code for every new OR reissue order. The code must be 15-20 characters long. Please use letters and numbers ONLY, no special characters.</p>
<p>We would generate the code on our own, IF no UNIQUE code will be provided</p>
<h6>Update to getOrderStatus method</h6>
<ol>
<li>"manual_check": "0"; if 1, order is under brand validation</li>
<li>"pre_signing": "0"; if 1, Comodo has too many orders and issuance of SSL delayed</li>
</ol>
<h6>Method: POST - /api/orders/add_ssl_order</h6>
<ol>
<li>HTTP selection method error fixed. Now dcv_method is required paramether</li>
<li>SAN count bug fixed</li>
<li>New order values:
<ul>
<li>dcv_method now accept `http`, `https`, `dns`, `email` for Comodo products</li>
<li>Symantec/GeoTrust/Thawte/RapidSSL accept only email method</li>
<li>approver_emails now accept `http`, `https`, `dns`, `my@email.com`. Please be careful!!! This params must be set only if certificate vendor is Comodo. For all Symantec products please remove it.</li>
</ul>
</li>
<li>If your account have NO funds order will be accepted and status will be set `unpaid` until you pay invoice </li>
<li>if you select `dcv_method` as `http`,`https`,`dns` the JSON return next block
<ul>
<li>{"approver_method": {<br>
<br>
"http": {
"http": {
"link": "http://gogetssl.com/961c6b85956bef80181de4cf2f2291b5.txt",
"filename": "961c6b85956bef80181de4cf2f2291b5.txt",
"content": "49478fb8228021d38b561e0c51adff3fcaa72caa\r\ncomodoca.com"
}
},<br>
<br>
"https": {
"https": {
"link": "https://gogetssl.com/961c6b85956bef80181de4cf2f2291b5.txt",
"filename": "961c6b85956bef80181de4cf2f2291b5.txt",
"content": "49478fb8228021d38b561e0c51adff3fcaa72caa\r\ncomodoca.com"
}
},<br>
<br>
"dns": {
"dns": {
"record": "961c6b85956bef80181de4cf2f2291b5.gogetssl.com. CNAME 49478fb8228021d38b561e0c51adff3fcaa72caa.comodoca.com."
}
}
},<br>
<br>
"order_id": 45755,<br>
"invoice_id": 48509,<br>
"order_status": "active",<br>
"success": true,<br>
"order_amount": 33.56,<br>
"currency": "EUR",<br>
"tax": "5.36",<br>
"tax_rate": "19%"
}</li>
</ul>
</li>
<li>The `approver_method` content array of additional validation methods, you must use yours selected in order method and use this data to validate domain name and SAN domains (if this is Multi domain product).</li>
</ol>
<h6>Method: POST<br>
/api/orders/ssl/<br>
change_validation_method/ORDER_ID</h6>
<OL>
<LI>
<ul>
<li>POST value: `domain` - CN/SAN domain name<br>
`new_method` - `my@email.com`, `dns`, `http`, `https`<br>
<br>
<b>Please be careful!!!</b><br>
For Thawte/Symantec/RapidSSL products only `email` method for Common name.<br>
<br>
</li>
<li>Method: POST - /api/orders/ssl/revalidate/ORDER_ID<br>
POST value: `domain` - CN/SAN domain name<br>
<br>
<strong> Please be careful!!! </strong><br>
Not working for Thawte/Symantec/RapidSSL products<br>
<br>
</li>
<li>Method: POST - /api/orders/ssl/resend/ORDER_ID<br>
POST value: `domain` - CN/SAN domain name<br>
<br>
<strong> Please be careful!!! </strong><br>
Working on all ssl products.<br>
<br>
</li>
<li>Method: GET - /api/orders/status/ORDER_ID<br>
new blocks in answer:<br>
<br>
"status_description": "Awaiting Validation (Full)" - Contain order status description<br>
"dcv_status" - Contain Common Name validation status. 1 - Proccessing, 2 - Validated. This field you can use only if this is Comodo product.<br>
"san": [<br>
{<br>
"san_name": "aaa.lv",<br>
"validation_method": "admin@aaa.lv",<br>
"status": "1",<br>
"status_description": "Proccessing"<br>
},<br>
{<br>
"san_name": "bbb.lv",<br>
"validation_method": "admin@bbb.lv",<br>
"status": "1",<br>
"status_description": "Proccessing"<br>
},<br>
{<br>
"san_name": "ccc.lv",<br>
"validation_method": "admin@ccc.lv",<br>
"status": "1",<br>
"status_description": "Proccessing"<br>
}<br>
], - SAN block information.<br>
<br>
For Thawte/Symantec/RapidSSL products this block and fields will be empty.<br>
san_name - SAN domain name.<br>
<br>
validation_method - used validation method.<br>
For Comodo posible values: `my@email.com`, `http`, `https`, `dns`.<br>
<br>
status - SAN domain validation status. 0 - Not set, 1 - Proccessing, 2 - Validated.<br>
status_description - SAN domain validation status description.</li>
</ul>
</LI>
</OL>
</div>
<div>
<h3 class="set-resell"><span></span><?php echo __('Module versions') ?></h3>
<ul class="list-row">
<li><i></i><?php echo('API v.1.0 / Release: 2013.01.10')?></li>
<li><i></i><?php echo('API v.1.1 / Release: 2013.05.24')?></li>
<li><i></i><?php echo('API v.1.2 / Release: 2014.09.12')?></li>
<li><i></i><?php echo('API v.1.3 / Release: 2015.08.03')?></li>
<li><i></i><?php echo('API v.2.0 / Release: 2016.10.15')?></li>
<li><i></i><?php echo('API v.2.1 / Release: 2017.07.20')?></li>
<li><i></i><?php echo('API v.2.2 / Release: 2017.07.21')?></li>
</ul>
</div>
</div>
</div>