Initial release of the Unifi API Client

2015-08-09 21:06:47 +02:00
commit 8ce264b2a0
11 changed files with 494 additions and 0 deletions
--- a/src/Client.php
+++ b/src/Client.php
@@ -0,0 +1,202 @@
+<?php
+
+namespace JVDS\UnifiApiClient;
+
+use GuzzleHttp\ClientInterface;
+use GuzzleHttp\Cookie\CookieJar;
+use GuzzleHttp\Exception\GuzzleException;
+use Psr\Http\Message\ResponseInterface;
+
+/**
+ * Unifi controller API client.
+ *
+ * Example usage:
+ * <code>
+ * use JVDS\UnifiApiClient\Client;
+ * use GuzzleHttp\Client as HttpClient;
+ *
+ * $apiClient = new Client(new HttpClient(['base_uri' => 'https://127.0.0.1:8443']));
+ * $apiClient->login('your_username', 'your_password');
+ * $apiClient->statistics('default'); // fetch statistics for default site
+ * </code>
+ *
+ * Unifi controllers come with a self signed certificate by default.
+ * To verify that you're connecting to your own unifi controller,
+ * you should download your controller's certificate.
+ * And the verify option should be set to the path of the downloaded certificate:
+ *
+ * <code>
+ * use JVDS\UnifiApiClient\Client;
+ * use GuzzleHttp\Client as HttpClient;
+ *
+ * $apiClient = new Client(
+ *     new HttpClient(['base_uri' => 'https://127.0.0.1:8443']),
+ *     ['verify' => '/your/unifi/cert.pem']
+ * );
+ * $apiClient->login('your_username', 'your_password');
+ * </code>
+ *
+ * It is also possible to use your own certificate in the unifi controller.
+ * More information about this is available at: http://wiki.ubnt.com/UniFi_FAQ#Custom_SSL_certificate
+ *
+ * @author Joris van de Sande
+ */
+class Client
+{
+    /**
+     * @var ClientInterface|null
+     */
+    private $client;
+
+    /**
+     * @var array
+     */
+    private $requestOptions;
+
+    /**
+     * @param ClientInterface $client
+     * @param array $requestOptions Guzzle request options that will be sent with every request
+     *
+     * @link http://docs.guzzlephp.org/en/latest/request-options.html
+     */
+    public function __construct(ClientInterface $client, array $requestOptions = [])
+    {
+        $this->client = $client;
+        $this->requestOptions = $this->getRequestOptions($requestOptions);
+    }
+
+    /**
+     * Login to the Unifi controller.
+     * You need to login before you can make other api requests.
+     *
+     * @param string $username username
+     * @param string $password password
+     *
+     * @throws GuzzleException in case of a login failure.
+     */
+    public function login($username, $password)
+    {
+        $this->post(
+            '/api/login',
+            ['username' => $username, 'password' => $password, 'strict' => true]
+        );
+    }
+
+    /**
+     * @throws GuzzleException in case of a failure.
+     */
+    public function logout()
+    {
+        $this->client->request('get', '/logout', ['allow_redirects' => false] + $this->requestOptions);
+    }
+
+    /**
+     * @param string $site
+     *
+     * @return ResponseInterface
+     * @throws GuzzleException
+     */
+    public function statistics($site)
+    {
+        return $this->get('/api/s/' . $site . '/stat/sta');
+    }
+
+    /**
+     * @param string $site
+     *
+     * @return ResponseInterface
+     * @throws GuzzleException
+     */
+    public function deviceStatistics($site)
+    {
+        return $this->get('/api/s/' . $site. '/stat/device');
+    }
+
+    /**
+     * Authorize a guest by mac address.
+     *
+     * @param string $site
+     * @param string $mac the mac address of the guest to authorize.
+     * @param int $minutes number of minutes to authorize guest.
+     * @param array $data associative array with extra data, i.e. up (kbps), down (kbps), bytes (MB)
+     *
+     * @return ResponseInterface
+     * @throws GuzzleException
+     */
+    public function authorizeGuest($site, $mac, $minutes, array $data = [])
+    {
+        return $this->post(
+            '/api/s/' . $site . '/cmd/stamgr',
+            [
+                'cmd' => 'authorize-guest',
+                'mac' => $mac,
+                'minutes' => $minutes
+            ] + $data
+        );
+    }
+
+    /**
+     * Unauthorize a guest by mac address.
+     *
+     * @param string $site
+     * @param string $mac
+     *
+     * @return ResponseInterface
+     */
+    public function unauthorizeGuest($site, $mac)
+    {
+
+        return $this->post(
+            '/api/s/' . $site . '/cmd/stamgr',
+            [
+                'cmd' => 'unauthorize-guest',
+                'mac' => $mac
+            ]
+        );
+    }
+
+    /**
+     * @param string $url (relative) url to the api endpoint
+     * @param array $data data to be sent with the request.
+     *
+     * @return ResponseInterface
+     * @throws GuzzleException
+     */
+    public function post($url, array $data = [])
+    {
+        return $this->client->request(
+            'post',
+            $url,
+            ['json' => $data] + $this->requestOptions
+        );
+    }
+
+    /**
+     * @param string $url
+     * @param array $data
+     *
+     * @return ResponseInterface
+     * @throws GuzzleException
+     */
+    public function get($url, array $data = [])
+    {
+        $requestOptions = $this->requestOptions;
+
+        if ($data) {
+            $requestOptions['query'] = $data;
+        }
+
+        return $this->client->request('get', $url, $requestOptions);
+    }
+
+    private function getRequestOptions(array $defaultRequestOptions)
+    {
+        return array_merge(
+            [
+                'cookies' => new CookieJar(),
+                'verify' => false
+            ],
+            $defaultRequestOptions
+        );
+    }
+}