Exemplo PHP

Exemplo de como implementar a requisição a API do CEP Aberto em PHP.

api/v3/api.php

@@ -0,0 +1,84 @@
+<?php
+
+class ServiceAPI {
+
+    private $key = 'Your_Access_Token';
+
+    // Function responsible for making requests in the API and returning the information in json.
+    function request($uri, $type_request) {
+        if (!empty($uri)){
+            try {
+                $request = curl_init();
+                curl_setopt ($request, CURLOPT_HTTPHEADER, array('Authorization: ' . $this->key)); // Access token for request.
+                curl_setopt ($request, CURLOPT_URL, $uri); // Request URL.
+                curl_setopt ($request, CURLOPT_RETURNTRANSFER, 1); 
+                curl_setopt ($request, CURLOPT_CONNECTTIMEOUT, 5); // Connect time out.
+                curl_setopt ($request, CURLOPT_CUSTOMREQUEST, $type_request); // HTPP Request Type.
+                $file_contents = curl_exec($request);
+                curl_close($request);
+
+                return $file_contents;
+
+            } catch (Exception $e){
+                return $e->getMessage();
+            }
+        }
+    }
+
+    // Preparation of parameters and URL for searching zip codes.
+    function getCep(){
+        $type_request = "GET";
+        $params = 'cep=95010000';
+        $uri = "https://www.cepaberto.com/api/v3/cep?". $params;
+
+        if (!empty($params)){
+            return $this->request($uri, $type_request);
+        }
+    }
+
+    // Preparation of parameters and URL for search of Addresses.
+    function getAddress(){
+        $link = null;
+        $type_request = "GET";
+        $params = array(
+            "estado" => "RS",
+            "cidade" => "Flores da Cunha",
+        );
+
+        if (is_array($params)){
+            foreach ($params as $type_key => $value){
+                if (empty($value)) continue;
+                $link .= $type_key . '=' . urlencode($value) . '&';
+            }
+
+            $params = substr($link, 0, -1);
+
+            if (!empty($params)){
+                $uri = "https://www.cepaberto.com/api/v3/address?". $params;
+                return $this->request($uri, $type_request);
+            }
+        }
+    }
+
+    // Preparation of parameters and URL for listing cities in a state.
+    function getCities(){
+        $type_request = "GET";
+        $params = 'RS';
+        $uri = "https://www.cepaberto.com/api/v3/cities?estado=". $params;
+
+        if (!empty($params)){
+            return $this->request($uri, $type_request);
+        }
+    }
+}
+
+    /*===============================TEST================================*/
+    $api = new ServiceAPI();
+    echo "<p style='color: #062cfb'>getCep </p>" . $api->getCep();
+    sleep(1);
+    echo "<p style='color: #062cfb'>getAddress </p>" . $api->getAddress();
+    sleep(1);
+    echo "<p style='color: #062cfb'>getCities </p>" . $api->getCities();
+    /*===============================TEST================================*/
+
+?>