├── .gitignore ├── README.md ├── cloudflare_class.php └── license /.gitignore: -------------------------------------------------------------------------------- 1 | example.php 2 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | ## cloudflare-api 3 | Just started this class not ready will add to examples for each completed method 4 | 5 | php binding for cloudflare api v4 6 | 7 | 8 | 9 | ### examples 10 | 11 | ```php 12 | $api = new cloudflare_api('example@example.com','agdegbhj1d0fe343dff8fddcb30131'); 13 | 14 | 15 | //get_zones 16 | $result = $api->get_zones(); 17 | 18 | //dns_records 19 | $identifier = $api->identifier('example.com'); 20 | $result = $api->dns_records($identifier); 21 | 22 | //get_dns_record 23 | $result = $api->get_dns_record($identifier,'A','example.com'); 24 | 25 | 26 | //create_dns_record | eg A record for ftp.example.com to point to 127.0.0.1 27 | $identifier = $api->identifier('example.com'); 28 | $result = $api->create_dns_record($identifier,'A','ftp','127.0.0.1'); 29 | 30 | //get_dns_record_id 31 | $dns_record_id = $api->get_dns_record_id($identifier,'A','ftp.example.com'); 32 | 33 | //update_dns_record 34 | $identifier = $api->identifier('example.com'); 35 | $dns_record_id = $api->get_dns_record_id($identifier,'A','ftp.example.com'); 36 | $response = $api->update_dns_record($identifier,$dns_record_id,'A','ftp','127.0.1.1'); 37 | 38 | //delete_dns_record 39 | $identifier = $api->identifier('example.com'); 40 | $dns_record_id = $api->get_dns_record_id($identifier,'A','ftp.example.com'); 41 | $response = $api->delete_dns_record($identifier,$dns_record_id); 42 | 43 | //purge_site 44 | $identifier = $api->identifier('example.com'); 45 | $result = $api->purge_site($identifier); 46 | 47 | //purge_files 48 | $identifier = $api->identifier('example.com'); 49 | $files = [ 50 | 'http://example.com/skin.css', 51 | 'http://example.com/skin.js' 52 | ]; 53 | $result = $api->purge_files($identifier,$files); 54 | 55 | //analytics 56 | $analytics = $api->analytics($identifier,-10080, 0); 57 | 58 | /** 59 | * User Section 60 | */ 61 | //get_user_details 62 | $user_details = $api->get_user_details(); 63 | 64 | //update_user_details 65 | $response = $api->update_user_details("first_name","last_name","telephone","country","zipcode"); 66 | 67 | ``` 68 | -------------------------------------------------------------------------------- /cloudflare_class.php: -------------------------------------------------------------------------------- 1 | auth_email = $parameters[0]; 36 | $this->auth_key = $parameters[1]; 37 | }else{ 38 | //throw error 39 | } 40 | 41 | } 42 | /** 43 | * identifier for domain 44 | */ 45 | public function identifier($domain){ 46 | $result = $this->get_zone($domain); 47 | if (isset($result->result) && count($result->result) == 1) 48 | return $result->result[0]->id; 49 | 50 | return false; 51 | } 52 | /** 53 | * analytics 54 | * @identifier 55 | * https://api.cloudflare.com/#zone-analytics-dashboard 56 | */ 57 | public function analytics($identifier, $since = -10080, $until = 0 , $continuous = true){ 58 | $continuous = ($continuous) ? "true" : "false";//need to pass as string 59 | $data = [ 60 | 'since' => $since, 61 | 'until' => $until, 62 | 'continuous' => $continuous 63 | ]; 64 | return $this->get('zones/'.$identifier.'/analytics/dashboard', $data); 65 | } 66 | /** 67 | * purge_files 68 | * @identifier 69 | * @files | Array 70 | */ 71 | public function purge_files($identifier, $files = []){ 72 | $data = [ 73 | 'files' => $files 74 | ]; 75 | return $this->delete('zones/'.$identifier.'/purge_cache', $data); 76 | } 77 | /** 78 | * purge_site 79 | */ 80 | public function purge_site($identifier){ 81 | $data = [ 82 | 'purge_everything' => true 83 | ]; 84 | return $this->delete('zones/'.$identifier.'/purge_cache',$data); 85 | } 86 | 87 | /** 88 | * dns_records 89 | */ 90 | public function dns_records($identifier){ 91 | return $this->get('zones/'.$identifier.'/dns_records',[]); 92 | } 93 | 94 | 95 | /** 96 | * get_dns_record_id 97 | * will return DNS id if only 1 record is found 98 | */ 99 | public function get_dns_record_id($identifier,$type = '' ,$domain = ''){ 100 | $response = $this->get_dns_record($identifier,$type,$domain); 101 | if ($response && count($response->result) == 1){ 102 | return $response->result[0]->id; 103 | } 104 | return "failed to get dns id use get_dns_record"; 105 | } 106 | /** 107 | * get_dns_record 108 | * https://api.cloudflare.com/#dns-records-for-a-zone-list-dns-records 109 | */ 110 | public function get_dns_record($identifier,$type = '' ,$domain = ''){ 111 | 112 | if (!in_array($type, self::$VALID_DNS_TYPES)) 113 | return "incorrect dns type"; 114 | 115 | $data = [ 116 | 'type' => $type, 117 | 'name' => $domain, 118 | 'per_page' => 20, 119 | 'order' => 'type', 120 | 'match' => 'all' 121 | ]; 122 | return $this->get('zones/'.$identifier.'/dns_records',$data); 123 | } 124 | /** 125 | * delete_dns_record 126 | * https://api.cloudflare.com/#dns-records-for-a-zone-delete-dns-record 127 | * @dns_record_id : DNS record ID 128 | */ 129 | public function delete_dns_record($identifier,$dns_record_id){ 130 | 131 | return $this->delete('zones/'.$identifier.'/dns_records/'.$dns_record_id,[]); 132 | } 133 | /** 134 | * update_dns_record 135 | * https://api.cloudflare.com/#dns-records-for-a-zone-update-dns-record 136 | * @type : A, AAAA, CNAME, TXT, SRV, LOC, MX, NS, SPF 137 | */ 138 | public function update_dns_record($identifier,$dns_record_id,$type,$name,$content,$ttl = 1){ 139 | 140 | if (!in_array($type, self::$VALID_DNS_TYPES)) 141 | return "incorrect dns type"; 142 | 143 | if($type === 'SRV'){ 144 | //$content = "$weight, $priority, $target, $service, $proto, $port" 145 | //Example: $content = "3, 5, examplewebpage.com, _web, _tcp, 8765" 146 | $contentData = explode(", ", $content); 147 | 148 | $data = [ 149 | "type" => $type, 150 | "data" => array( 151 | "name" => $name, 152 | "weight" => $contentData[0], 153 | "priority" => $contentData[1], 154 | "target" => $contentData[2], 155 | "service" => $contentData[3], 156 | "proto" => $contentData[4], 157 | "port" => $contentData[5], 158 | "ttl" => $ttl 159 | ) 160 | ]; 161 | }else{ 162 | $data = [ 163 | 'type' => $type, 164 | 'name' => $name, 165 | 'content' => $content, 166 | 'ttl' => $ttl 167 | ]; 168 | } 169 | return $this->put('zones/'.$identifier.'/dns_records/'.$dns_record_id,$data); 170 | } 171 | /** 172 | * create_dns_record 173 | * https://api.cloudflare.com/#dns-records-for-a-zone-create-dns-record 174 | * @type : A, AAAA, CNAME, TXT, SRV, LOC, MX, NS, SPF 175 | */ 176 | public function create_dns_record($identifier,$type,$name,$content,$ttl = 1){ 177 | 178 | if (!in_array($type, self::$VALID_DNS_TYPES)) 179 | return "incorrect dns type"; 180 | 181 | if($type === 'SRV'){ 182 | //$content = "$weight, $priority, $target, $service, $proto, $port" 183 | //Example: $content = "3, 5, examplewebpage.com, _web, _tcp, 8765" 184 | $contentData = explode(", ", $content); 185 | 186 | $data = [ 187 | "type" => $type, 188 | "data" => array( 189 | "name" => $name, 190 | "weight" => $contentData[0], 191 | "priority" => $contentData[1], 192 | "target" => $contentData[2], 193 | "service" => $contentData[3], 194 | "proto" => $contentData[4], 195 | "port" => $contentData[5], 196 | "ttl" => $ttl 197 | ) 198 | ]; 199 | }else{ 200 | $data = [ 201 | 'type' => $type, 202 | 'name' => $name, 203 | 'content' => $content, 204 | 'ttl' => $ttl 205 | ]; 206 | } 207 | return $this->post('zones/'.$identifier.'/dns_records',$data); 208 | } 209 | /** 210 | * purge_site 211 | */ 212 | public function get_zone($name){ 213 | $data = [ 214 | 'name' => $name, 215 | 'status' => 'active', 216 | 'page' => 1, 217 | 'match' => 'all' 218 | ]; 219 | return $this->get('zones',$data); 220 | } 221 | /** 222 | * purge_site 223 | */ 224 | public function get_zones(){ 225 | return $this->get('zones',[]); 226 | } 227 | 228 | /** 229 | * User Section 230 | */ 231 | 232 | 233 | /** 234 | * get_user_details 235 | * https://api.cloudflare.com/#user-user-details 236 | */ 237 | public function get_user_details(){ 238 | return $this->get('user',[]); 239 | } 240 | /** 241 | * update_user_details 242 | * https://api.cloudflare.com/#user-user-details 243 | */ 244 | public function update_user_details($first_name,$last_name,$telephone,$country,$zipcode){ 245 | $data = [ 246 | "first_name" => $first_name, 247 | "last_name" => $last_name, 248 | "telephone" => $telephone, 249 | "country" => $country, 250 | "zipcode" => $zipcode 251 | ]; 252 | return $this->patch('user',$data); 253 | } 254 | 255 | //privates below 256 | /** 257 | * delete 258 | */ 259 | private function delete($endpoint,$data){ 260 | return $this->http_request($endpoint,$data,'delete'); 261 | } 262 | /** 263 | * post 264 | */ 265 | private function post($endpoint,$data){ 266 | return $this->http_request($endpoint,$data,'post'); 267 | } 268 | /** 269 | * get 270 | */ 271 | private function get($endpoint,$data){ 272 | return $this->http_request($endpoint,$data,'get'); 273 | } 274 | /** 275 | * put 276 | */ 277 | private function put($endpoint,$data){ 278 | return $this->http_request($endpoint,$data,'put'); 279 | } 280 | /** 281 | * patch 282 | */ 283 | private function patch($endpoint,$data){ 284 | return $this->http_request($endpoint,$data,'patch'); 285 | } 286 | /** 287 | * Handle http request to cloudflare server 288 | */ 289 | private function http_request($endpoint,$data, $method) 290 | { 291 | //setup url 292 | $url = $this->URL.$endpoint; 293 | 294 | //echo $url;exit; 295 | 296 | //headers set 297 | $headers = ["X-Auth-Email: {$this->auth_email}", "X-Auth-Key: {$this->auth_key}"]; 298 | $headers[] = 'Content-type: application/json'; 299 | 300 | //json encode data 301 | $json_data = json_encode($data); 302 | 303 | $ch = curl_init(); 304 | curl_setopt($ch, CURLOPT_VERBOSE, 0); 305 | curl_setopt($ch, CURLOPT_FORBID_REUSE, true); 306 | 307 | curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1); 308 | 309 | curl_setopt($ch, CURLOPT_TIMEOUT, self::TIMEOUT); 310 | curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false); 311 | 312 | if ($method === 'post') 313 | curl_setopt($ch, CURLOPT_POST, true); 314 | 315 | if ($method === 'put') 316 | curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PUT'); 317 | 318 | if ($method === 'delete') 319 | curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE'); 320 | 321 | if ($method === 'patch') 322 | curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH'); 323 | 324 | //get request otherwise pass post data 325 | if (!isset($method) || $method == 'get') 326 | $url .= '?'.http_build_query($data); 327 | else 328 | curl_setopt($ch, CURLOPT_POSTFIELDS, $json_data); 329 | //echo $url; 330 | 331 | //add headers 332 | curl_setopt($ch, CURLOPT_HTTPHEADER, $headers); 333 | curl_setopt($ch, CURLOPT_URL, $url); 334 | 335 | 336 | $http_response = curl_exec($ch); 337 | $error = curl_error($ch); 338 | $http_code = curl_getinfo($ch, CURLINFO_HTTP_CODE); 339 | curl_close($ch); 340 | 341 | 342 | if ($http_code != 200) { 343 | //hit error will add in error checking but for now will return back to user to handle 344 | return json_decode($http_response); 345 | } else { 346 | return json_decode($http_response); 347 | } 348 | } 349 | } 350 | -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------