├── README ├── namecheap.php └── LICENSE /README: -------------------------------------------------------------------------------- 1 | Namecheap-REST-PHP - a simple PHP library for using the Namecheap REST API 2 | http://developer.namecheap.com/docs/doku.php?id=api-reference:index 3 | 4 | *** ABOUT *** 5 | This is a simple single-file class for accessing the Namecheap REST API. 6 | 7 | Methods are loosely named after the corresponding API endpoint. 8 | 9 | namecheap.domains.check == domainsCheck() 10 | namecheap.domains.create == domainsCreate() 11 | namecheap.domains.ns.create == nsCreate() 12 | namecheap.domains.dns.setCustom == dnsSetCustom() 13 | 14 | The class fully supports the Namecheap Sandbox (https://www.sandbox.namecheap.com) during object construction. 15 | 16 | The raw response from the Namecheap API is available as a public variable "$Raw". Any call the results in an error stores the full error in a public variable "$Error". 17 | 18 | *** USAGE *** 19 | include_once( 'namecheap.php' ); 20 | $nc_api = array( 'api_user' => 'username', 21 | 'api_key' => 'some_key', 22 | 'api_ip' => 'detect' 23 | ); 24 | $sandbox = 'true'; // use the Namecheap sandbox to test 25 | $nc = new Namecheap( $nc_api, $sandbox ); 26 | if ( $nc->domainsCheck( 'example.com' ) ) { 27 | echo "

example.com is available!

"; 28 | } 29 | $domains = array( 'example.net', 'example.org', 'example.info' ); 30 | $results = $nc->domainsCheck( $domains ); 31 | echo ""; 37 | 38 | // registering a domain requires an awful lof of mandatory data: 39 | // http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:create 40 | // stick all that in an associative array 41 | if ( ! $nc->domainCreate( 'example.com', $registration_data ) ) { 42 | print_r( $nc->Error ); 43 | } 44 | 45 | *** LICENSE *** 46 | Copyright 2011 Scott Merrill 47 | 48 | Licensed under the Apache License, Version 2.0 (the "License"); 49 | you may not use this file except in compliance with the License. 50 | You may obtain a copy of the License at 51 | 52 | http://www.apache.org/licenses/LICENSE-2.0 53 | 54 | Unless required by applicable law or agreed to in writing, software 55 | distributed under the License is distributed on an "AS IS" BASIS, 56 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 57 | See the License for the specific language governing permissions and 58 | limitations under the License. 59 | -------------------------------------------------------------------------------- /namecheap.php: -------------------------------------------------------------------------------- 1 | api_url = 'https://api.sandbox.namecheap.com/xml.response'; 26 | } else { 27 | $this->api_url = 'https://api.namecheap.com/xml.response'; 28 | } 29 | $this->api_user = $credentials['api_user']; 30 | $this->api_key = $credentials['api_key']; 31 | $this->api_ip = ( 'detect' == $credentials['api_ip'] ) ? $this->detect_ip() : $credentials['api_ip']; 32 | } 33 | 34 | /* 35 | * determine our IP address 36 | * @return string our public IP address, as seen by icanhazip.com 37 | */ 38 | public function detect_ip() 39 | { 40 | $ch = curl_init( 'http://icanhazip.com' ); 41 | curl_setopt( $ch, CURLOPT_RETURNTRANSFER, TRUE ); 42 | $result = rtrim(curl_exec( $ch ) ); 43 | curl_close( $ch ); 44 | return $result; 45 | } 46 | 47 | /* 48 | * execute a call to the Namecheap API 49 | * @command string the name of the API call to invoke 50 | * @args array associative array of options for the API call 51 | * @return bool success or failure 52 | */ 53 | private function execute( $command, $args = array() ) 54 | { 55 | // blank out any previous values for these 56 | $this->Error = ''; 57 | $this->Response = ''; 58 | $this->Raw = ''; 59 | 60 | $url = $this->api_url . 61 | '?ApiUser=' . $this->api_user . 62 | '&ApiKey=' . $this->api_key . 63 | '&UserName=' . $this->api_user . 64 | '&ClientIP=' . $this->api_ip . 65 | '&Command=' . $command; 66 | foreach ( $args as $arg => $value ) 67 | { 68 | $url .= "&$arg="; 69 | $url .= urlencode( $value ); 70 | } 71 | $ch = curl_init( $url ); 72 | curl_setopt( $ch, CURLOPT_RETURNTRANSFER, TRUE ); 73 | $result = curl_exec( $ch ); 74 | curl_close( $ch ); 75 | if ( FALSE == $result ) { 76 | $this->Error = 'Communication error with Namecheap.'; 77 | return FALSE; 78 | } 79 | $xml = new SimpleXMLElement( $result ); 80 | $this->Raw = $xml; 81 | if ( 'ERROR' == $xml['Status'] ) 82 | { 83 | $this->Error = (string) $xml->Errors->Error; 84 | return FALSE; 85 | } elseif ( 'OK' == $xml['Status'] ) 86 | { 87 | $this->Response = $xml->CommandResponse; 88 | return true; 89 | } 90 | } 91 | 92 | /* 93 | * check the availability of one or more domains 94 | * @domains mixed array, comma delimited list, or single domain name 95 | * @return mixed associative array of domains => status, 96 | * or boolean if only a single domain is being checked 97 | */ 98 | public function domainsCheck( $domains ) 99 | { 100 | if ( is_array( $domains ) ) { 101 | $domains = implode( ',', $domains ); 102 | } 103 | if ( ! $this->execute( 'namecheap.domains.check', array( 'DomainList' => $domains ) ) ) { 104 | // communication error 105 | return FALSE; 106 | } 107 | if ( FALSE === strpos( $domains, ',' ) ) { 108 | //only one domain was passed, so just return 109 | // the availability of that domain 110 | $status = ( 'true' == strtolower( (string)$this->Response->DomainCheckResult->attributes()->Available ) ) ? TRUE : FALSE; 111 | return $status; 112 | } 113 | $r = array(); 114 | foreach ( $this->Response->DomainCheckResult as $result ) { 115 | $domain = (string)$result['Domain']; 116 | $status = ( 'true' == strtolower( (string)$result['Available'] ) ) ? TRUE : FALSE; 117 | $r[$domain] = $status; 118 | } 119 | return $r; 120 | } 121 | 122 | /* 123 | * register a domain 124 | * @domain string the domain name to register 125 | * @data array associative array of required registration data 126 | * http://developer.namecheap.com/docs/doku.php?id=api-reference:domains:create 127 | * @return bool success or failure of the registration 128 | */ 129 | public function domainsCreate( $domain, $data ) 130 | { 131 | $data['DomainName'] = $domain; 132 | if ( ! $this->execute( 'namecheap.domains.create', $data ) ) { 133 | return FALSE; 134 | } 135 | if ( 'true' == strtolower( $this->Response->DomainCreateResult->attributes()->Registered ) ) 136 | { 137 | return TRUE; 138 | } 139 | return FALSE; 140 | } 141 | 142 | /* 143 | * return a list of domains we own 144 | * @type string All, Expiring, or Expired. Defaults to All 145 | * @page int page number to return 146 | * @pagesize int number of domains per page. minimum 10, max 100. 147 | * @sort string NAME, NAME_DESC, EXPIREDATE, EXPIREDATE_DESC, CREATEDATE, CREATEDATE_DESC 148 | * @search string specific name for which to search 149 | * @return mixed an array of domains or boolean false 150 | */ 151 | public function domainsGetList( $type = 'all', $page = 1, $pagesize = 100, $sort = 'NAME', $search = '') 152 | { 153 | if ( ! $this->execute( 'namecheap.domains.getList', array( 'ListType' => $type, 'SearchTerm' => $search, 'Page' => $page, 'PageSize' => $pagesize, 'SortBy' => $sort ) ) ) { 154 | return FALSE; 155 | } 156 | $domains = array(); 157 | foreach ( $this->Response->DomainGetListResult->Domain as $domain ) { 158 | $x = array(); 159 | foreach( $domain->attributes() as $k => $v ) { 160 | $x[$k] = (string)$v; 161 | } 162 | $domains[] = $x; 163 | } 164 | return $domains; 165 | } 166 | 167 | /* 168 | * create new nameservers 169 | * @domain string domain name to which these nameservers will be assigned 170 | * @nameserver string the FQDN of the nameserver to create 171 | * @ip string the IP address of the nameserver to create 172 | * @return bool success or failure 173 | */ 174 | public function nsCreate( $domain, $nameserver, $ip ) 175 | { 176 | list( $sld, $tld ) = explode( '.', $domain ); 177 | $args['SLD'] = $sld; 178 | $args['TLD'] = $tld; 179 | $args['Nameserver'] = $nameserver; 180 | $args['IP'] = $ip; 181 | if ( $this->execute( 'namecheap.domains.ns.create', $args ) ) { 182 | return TRUE; 183 | } 184 | return $false; 185 | } 186 | 187 | /* 188 | * assign nameservers to a domain 189 | * @domain string the domain name that will be assigned nameservers 190 | * @nameservers mixed an array or comma delimited list of nameservers 191 | * @return bool success or failure 192 | */ 193 | public function dnsSetCustom( $domain, $nameservers ) 194 | { 195 | if ( is_array( $nameservers ) ) { 196 | $nameservers = implode( ',', $nameservers ); 197 | } 198 | list( $sld, $tld ) = explode( '.', $domain ); 199 | $args['SLD'] = $sld; 200 | $args['TLD'] = $tld; 201 | $args['NameServers'] = $nameservers; 202 | if ( ! $this->execute( 'namecheap.domains.dns.setCustom', $args ) ) { 203 | return FALSE; 204 | } 205 | if ( 'true' == strtolower( $this->Response->DomainDNSSetCustomResult->attributes()->Updated ) ) 206 | { 207 | return TRUE; 208 | } 209 | return FALSE; 210 | } 211 | 212 | /* 213 | * configure a domain to use Namecheap's default nameservers 214 | * @domain string the domain to set 215 | * @return bool success or failure 216 | */ 217 | public function dnsSetDefault( $domain ) 218 | { 219 | list( $sld, $tld ) = explode( '.', $domain ); 220 | if ( ! $this->execute( 'namecheap.domains.dns.SetDefault', array( 'SLD' => $sld, 'TLD' => $tld ) ) ) { 221 | return FALSE; 222 | } 223 | if ( 'true' == strtolower( $this->Response->DomainDNSSetDefaultResult->attributes()->Updated ) ) { 224 | return TRUE; 225 | } 226 | return FALSE; 227 | } 228 | 229 | /* 230 | * get a list of DNS servers for a domain 231 | * @domain string the domain to query 232 | * @return mixed an array of nameservers, or boolean false 233 | */ 234 | public function dnsGetList( $domain ) 235 | { 236 | list( $sld, $tld ) = explode( '.', $domain ); 237 | if ( ! $this->execute( 'namecheap.domains.dns.getList', array( 'SLD' => $sld, 'TLD' => $tld ) ) ) { 238 | return FALSE; 239 | } 240 | $servers = array(); 241 | foreach ( $this->Response->DomainDNSGetListResult->Nameserver as $ns ) { 242 | $servers[] = (string)$ns; 243 | } 244 | return $servers; 245 | } 246 | 247 | /* 248 | * set DNS host records for the specified domain 249 | * @domain string domain for which the record should be defined 250 | * @data array associative array of record details to set 251 | * @return bool success or failure 252 | */ 253 | public function dnsSetHosts( $domain, $data ) 254 | { 255 | list( $data['SLD'], $data['TLD'] ) = explode( '.', $domain ); 256 | if ( ! $this->execute( 'namecheap.domains.dns.setHosts', $data ) ) { 257 | return FALSE; 258 | } 259 | if ( 'true' == strtolower( $this->Response->DomainDNSSetHostsResult->attributes()->IsSuccess ) ) { 260 | return TRUE; 261 | } 262 | return FALSE; 263 | } 264 | 265 | /* 266 | * return the balance of an account 267 | * @return mixed an array of balance information, or boolean false 268 | */ 269 | public function usersGetBalances() 270 | { 271 | if( ! $this->execute( 'namecheap.users.getBalances' ) ) { 272 | return FALSE; 273 | } 274 | foreach ( $this->Response->UserGetBalancesResult->attributes() as $k => $v ) { 275 | $balance[$k] = (string)$v; 276 | } 277 | return $balance; 278 | } 279 | 280 | /* 281 | * return pricing information for TLDs 282 | * @type string one of DOMAIN, SSLCERTIFICATE or WHOISGUARD 283 | * @category string specific category within product type 284 | * @promo string promotional code 285 | * http://developer.namecheap.com/docs/doku.php?id=api-reference:users:getpricing 286 | * @return mixed 287 | */ 288 | public function getPricing( $type = 'DOMAIN', $category ='', $promo = '' ) 289 | { 290 | $args = array( 'ProductType' => $type ); 291 | if ( ! empty( $category ) ) 292 | { 293 | $args['ProductCategory'] = $category; 294 | } 295 | if ( ! empty( $promo ) ) 296 | { 297 | $args['PromotionCode'] = $promo; 298 | } 299 | $this->execute( 'namecheap.users.getPricing', $args ); 300 | } 301 | } 302 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "[]" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright [yyyy] [name of copyright owner] 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | 203 | --------------------------------------------------------------------------------