Skip to content

Commit c75e2c5

Browse files
malle-pietjemalle-pietje
committed
UniFi API browser 2.0.15
- changed references to UbiOS back to UniFi OS - updated PHP API client to 1.1.63
1 parent d67ff45 commit c75e2c5

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

89 files changed

+981
-1127
lines changed

‎README.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,8 @@ You will find examples and detailed instructions there.
1111
Please keep the following in mind:
1212

1313
- the API browser tool doesn't support all available data collections/API endpoints, see the list below of those that are currently supported
14-
- currently, versions 4.x.x, 5.x.x, and 6.0.x of the UniFi Controller software are supported (version 6.0.42 has been confirmed to work) as well as UbiOS-based controllers (version 5.12.59 has been confirmed to work)
15-
- when accessing UbiOS-based controllers (e.g. UDM PRO) through this tool, please read the remarks below regarding UbiOS support
14+
- currently, versions 4.x.x, 5.x.x, and 6.0.x of the UniFi Controller software are supported (version 6.0.42 has been confirmed to work) as well as UniFi OS-based controllers (version 5.12.59 has been confirmed to work)
15+
- when accessing UniFi OS-based controllers (e.g. UDM PRO) through this tool, please read the remarks below regarding UniFi OS support
1616
- there is still work to be done to add/improve functionality and usability of this tool so suggestions/comments are welcome. Please use the GitHub [issue](https://github.com/Art-of-WiFi/UniFi-API-browser/issues) list or the Ubiquiti Community forums (https://community.ubnt.com/t5/UniFi-Wireless/UniFi-API-browser-tool-released/m-p/1392651) to share your ideas/questions.
1717
- please read the Security Notice below before installing this tool!
1818

@@ -142,9 +142,9 @@ Alternatively you may choose to download the zip file and unzip it in your direc
142142
- after following these steps, you can open the tool in your browser (assuming you installed it in the root folder of your web server as suggested above) by going to this url: `http(s)://<server IP address>/UniFi-API-browser/`
143143

144144

145-
### UbiOS support
145+
### UniFi OS support
146146

147-
Support for UbiOS-based controllers (UniFi Dream Machine Pro) has been added with version 2.0.7. When adding the details for a UbiOS device to the `config/config.php` file, please make sure not to add a port suffix or trailing slashes to the URL.
147+
Support for UniFi OS-based controllers (UniFi Dream Machine Pro) has been added with version 2.0.7. When adding the details for a UniFi OS device to the `config/config.php` file, please make sure not to add a port suffix or trailing slashes to the URL.
148148

149149

150150
### Extending the dropdown menu

‎common.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
* with this package in the file LICENSE.md
88
*
99
*/
10-
define('TOOL_VERSION', '2.0.14');
10+
define('TOOL_VERSION', '2.0.15');
1111

1212
/**
1313
* gather some basic information for the About modal

‎composer.lock‎

Lines changed: 16 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎vendor/art-of-wifi/unifi-api-client/README.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## UniFi Controller API client class
22

3-
A PHP class that provides access to Ubiquiti's [**UniFi Network Controller**](https://unifi-network.ui.com/) API, versions 4.X.X, 5.X.X and 6.0.X of the UniFi Network Controller software are supported (version 6.0.37 has been confirmed to work) as well as UbiOS-based controllers (version 5.12.59 has been confirmed to work). This class is used by our API browser tool which can be found [here](https://github.com/Art-of-WiFi/UniFi-API-browser).
3+
A PHP class that provides access to Ubiquiti's [**UniFi Network Controller**](https://unifi-network.ui.com/) API, versions 4.X.X, 5.X.X and 6.0.X of the UniFi Network Controller software are supported (version 6.0.42 has been confirmed to work) as well as UniFi OS-based controllers (version 5.12.59 has been confirmed to work). This class is used by our API browser tool which can be found [here](https://github.com/Art-of-WiFi/UniFi-API-browser).
44

55
The package can be installed manually or by using composer/[packagist](https://packagist.org/packages/art-of-wifi/unifi-api-client) for easy inclusion in your projects.
66

@@ -11,11 +11,11 @@ The package can be installed manually or by using composer/[packagist](https://p
1111
- you must use **local accounts**, not UniFi Cloud accounts, to access the UniFi Controller API through this class
1212

1313

14-
## UbiOS Support
14+
## UniFi OS Support
1515

16-
Support for UbiOS-based controllers (UniFi Dream Machine Pro) has been added as of version 1.1.47. The class automatically detects UbiOS devices and adjusts URLs and several functions/methods accordingly. If your own code applies strict validation of the URL that is passed to the constructor, please adapt your logic to allow URLs without a port suffix when dealing with a UbiOS-based controller.
16+
Support for UniFi OS-based controllers (UniFi Dream Machine Pro) has been added as of version 1.1.47. The class automatically detects UniFi OS devices and adjusts URLs and several functions/methods accordingly. If your own code applies strict validation of the URL that is passed to the constructor, please adapt your logic to allow URLs without a port suffix when dealing with a UniFi OS-based controller.
1717

18-
Please test all methods you plan on using thoroughly before using the API Client with UbiOS devices in a production environment.
18+
Please test all methods you plan on using thoroughly before using the API Client with UniFi OS devices in a production environment.
1919

2020
## Installation
2121

@@ -300,7 +300,7 @@ This class is based on the initial work by the following developers:
300300

301301
and the API as published by Ubiquiti:
302302

303-
- https://dl.ui.com/unifi/5.12.35/unifi_sh_api
303+
- https://dl.ui.com/unifi/6.0.41/unifi_sh_api
304304

305305
## Important Disclaimer
306306

‎vendor/art-of-wifi/unifi-api-client/src/Client.php‎

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@
1010
* and the API as published by Ubiquiti:
1111
* https://www.ubnt.com/downloads/unifi/<UniFi controller version number>/unifi_sh_api
1212
*
13-
* @package UniFi Controller API client class
13+
* @package UniFi_Controller_API_Client_Class
1414
* @author Art of WiFi <[email protected]>
15-
* @version 1.1.62
15+
* @version Release: 1.1.63
1616
* @license This class is subject to the MIT license that is bundled with this package in the file LICENSE.md
1717
* @example This directory in the package repository contains a collection of examples:
1818
* https://github.com/Art-of-WiFi/UniFi-API-client/tree/master/examples
@@ -31,7 +31,7 @@ class Client
3131
protected $is_loggedin = false;
3232
protected $is_unifi_os = false;
3333
protected $exec_retries = 0;
34-
protected $class_version = '1.1.62';
34+
protected $class_version = '1.1.63';
3535
private $cookies = '';
3636
private $request_type = 'GET';
3737
private $request_types_allowed = ['GET', 'POST', 'PUT', 'DELETE', 'PATCH'];
@@ -160,7 +160,7 @@ public function login()
160160
$curl_options = [
161161
CURLOPT_NOBODY => false,
162162
CURLOPT_POSTFIELDS => json_encode(['username' => $this->user, 'password' => $this->password]),
163-
CURLOPT_HTTPHEADER => ['content-type: application/json; charset=utf-8'],
163+
CURLOPT_HTTPHEADER => ['content-type: application/json'],
164164
CURLOPT_REFERER => $this->baseurl . '/login',
165165
CURLOPT_URL => $this->baseurl . '/api/login'
166166
];
@@ -260,7 +260,7 @@ public function logout()
260260
/**
261261
* constuct HTTP request headers as required
262262
*/
263-
$headers = ['Content-Length: 0'];
263+
$headers = ['content-length: 0'];
264264
$logout_path = '/logout';
265265
if ($this->is_unifi_os) {
266266
$logout_path = '/api/auth/logout';
@@ -3420,9 +3420,9 @@ public function set_ssl_verify_host($ssl_verify_host)
34203420
}
34213421

34223422
/**
3423-
* Is current controller UnifiOS-based/UbiOS-based
3423+
* Is current controller UniFi OS-based
34243424
*
3425-
* @return bool whether current controller is UnifiOS-based/UbiOS-based
3425+
* @return bool whether current controller is UniFi OS-based
34263426
*/
34273427
public function get_is_unifi_os()
34283428
{
@@ -3599,7 +3599,7 @@ private function catch_json_last_error()
35993599
break;
36003600
default:
36013601
// we have an unknown error
3602-
$error = 'Unknown JSON error occured';
3602+
$error = 'Unknown JSON error occurred';
36033603
break;
36043604
}
36053605

@@ -3718,7 +3718,11 @@ protected function exec_curl($path, $payload = null)
37183718
return false;
37193719
}
37203720

3721+
/**
3722+
* assigne default values to these vars
3723+
*/
37213724
$json_payload = '';
3725+
$headers = [];
37223726

37233727
if ($this->is_unifi_os) {
37243728
$url = $this->baseurl . '/proxy/network' . $path;
@@ -3733,39 +3737,25 @@ protected function exec_curl($path, $payload = null)
37333737
CURLOPT_URL => $url
37343738
];
37353739

3740+
/**
3741+
* what we do when a payload is passed
3742+
*/
37363743
if (!is_null($payload)) {
37373744
$json_payload = json_encode($payload, JSON_UNESCAPED_SLASHES);
37383745
$curl_options[CURLOPT_POST] = true;
37393746
$curl_options[CURLOPT_POSTFIELDS] = $json_payload;
37403747

37413748
$headers = [
3742-
'Content-Type: application/json;charset=UTF-8',
3743-
'Content-Length: ' . strlen($json_payload)
3749+
'content-type: application/json',
3750+
'content-length: ' . strlen($json_payload)
37443751
];
37453752

3746-
if ($this->is_unifi_os) {
3747-
$csrf_token = $this->extract_csrf_token_from_cookie();
3748-
if ($csrf_token) {
3749-
$headers[] = 'x-csrf-token: ' . $csrf_token;
3750-
}
3751-
}
3752-
3753-
$curl_options[CURLOPT_HTTPHEADER] = $headers;
3754-
37553753
/**
37563754
* we shouldn't be using GET (the default request type) or DELETE when passing a payload,
37573755
* switch to POST instead
37583756
*/
3759-
switch ($this->request_type) {
3760-
case 'GET':
3761-
$this->request_type = 'POST';
3762-
break;
3763-
case 'DELETE':
3764-
$this->request_type = 'POST';
3765-
break;
3766-
case 'PUT':
3767-
$curl_options[CURLOPT_CUSTOMREQUEST] = 'PUT';
3768-
break;
3757+
if ($this->request_type === 'GET' || $this->request_type === 'DELETE') {
3758+
$this->request_type = 'POST';
37693759
}
37703760
}
37713761

@@ -3779,6 +3769,20 @@ protected function exec_curl($path, $payload = null)
37793769
case 'POST':
37803770
$curl_options[CURLOPT_CUSTOMREQUEST] = 'POST';
37813771
break;
3772+
case 'PUT':
3773+
$curl_options[CURLOPT_CUSTOMREQUEST] = 'PUT';
3774+
break;
3775+
}
3776+
3777+
if ($this->is_unifi_os && $this->request_type !== 'GET') {
3778+
$csrf_token = $this->extract_csrf_token_from_cookie();
3779+
if ($csrf_token) {
3780+
$headers[] = 'x-csrf-token: ' . $csrf_token;
3781+
}
3782+
}
3783+
3784+
if (count($headers) > 0) {
3785+
$curl_options[CURLOPT_HTTPHEADER] = $headers;
37823786
}
37833787

37843788
curl_setopt_array($ch, $curl_options);

‎vendor/composer/installed.json‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,25 @@
11
[
22
{
33
"name": "art-of-wifi/unifi-api-client",
4-
"version": "v1.1.62",
5-
"version_normalized": "1.1.62.0",
4+
"version": "v1.1.63",
5+
"version_normalized": "1.1.63.0",
66
"source": {
77
"type": "git",
88
"url": "https://github.com/Art-of-WiFi/UniFi-API-client.git",
9-
"reference": "c82481a28a7cca2f96686e291826bf2f2854784d"
9+
"reference": "a4998de3a9f2e9bfc61f46adcd19999c0b9fe360"
1010
},
1111
"dist": {
1212
"type": "zip",
13-
"url": "https://api.github.com/repos/Art-of-WiFi/UniFi-API-client/zipball/c82481a28a7cca2f96686e291826bf2f2854784d",
14-
"reference": "c82481a28a7cca2f96686e291826bf2f2854784d",
13+
"url": "https://api.github.com/repos/Art-of-WiFi/UniFi-API-client/zipball/a4998de3a9f2e9bfc61f46adcd19999c0b9fe360",
14+
"reference": "a4998de3a9f2e9bfc61f46adcd19999c0b9fe360",
1515
"shasum": ""
1616
},
1717
"require": {
1818
"ext-curl": "*",
1919
"ext-json": "*",
2020
"php": ">=5.5.0"
2121
},
22-
"time": "2020-12-10T13:52:39+00:00",
22+
"time": "2021-01-06T16:03:21+00:00",
2323
"type": "library",
2424
"installation-source": "dist",
2525
"autoload": {
@@ -111,17 +111,17 @@
111111
},
112112
{
113113
"name": "symfony/polyfill-ctype",
114-
"version": "v1.20.0",
115-
"version_normalized": "1.20.0.0",
114+
"version": "v1.22.0",
115+
"version_normalized": "1.22.0.0",
116116
"source": {
117117
"type": "git",
118118
"url": "https://github.com/symfony/polyfill-ctype.git",
119-
"reference": "f4ba089a5b6366e453971d3aad5fe8e897b37f41"
119+
"reference": "c6c942b1ac76c82448322025e084cadc56048b4e"
120120
},
121121
"dist": {
122122
"type": "zip",
123-
"url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/f4ba089a5b6366e453971d3aad5fe8e897b37f41",
124-
"reference": "f4ba089a5b6366e453971d3aad5fe8e897b37f41",
123+
"url": "https://api.github.com/repos/symfony/polyfill-ctype/zipball/c6c942b1ac76c82448322025e084cadc56048b4e",
124+
"reference": "c6c942b1ac76c82448322025e084cadc56048b4e",
125125
"shasum": ""
126126
},
127127
"require": {
@@ -130,11 +130,11 @@
130130
"suggest": {
131131
"ext-ctype": "For best performance"
132132
},
133-
"time": "2020-10-23T14:02:19+00:00",
133+
"time": "2021-01-07T16:49:33+00:00",
134134
"type": "library",
135135
"extra": {
136136
"branch-alias": {
137-
"dev-main": "1.20-dev"
137+
"dev-main": "1.22-dev"
138138
},
139139
"thanks": {
140140
"name": "symfony/polyfill",
@@ -189,17 +189,17 @@
189189
},
190190
{
191191
"name": "twig/twig",
192-
"version": "v1.44.1",
193-
"version_normalized": "1.44.1.0",
192+
"version": "v1.44.2",
193+
"version_normalized": "1.44.2.0",
194194
"source": {
195195
"type": "git",
196196
"url": "https://github.com/twigphp/Twig.git",
197-
"reference": "04b15d4c0bb18ddbf82626320ac07f6a73f199c9"
197+
"reference": "138c493c5b8ee7cff3821f80b8896d371366b5fe"
198198
},
199199
"dist": {
200200
"type": "zip",
201-
"url": "https://api.github.com/repos/twigphp/Twig/zipball/04b15d4c0bb18ddbf82626320ac07f6a73f199c9",
202-
"reference": "04b15d4c0bb18ddbf82626320ac07f6a73f199c9",
201+
"url": "https://api.github.com/repos/twigphp/Twig/zipball/138c493c5b8ee7cff3821f80b8896d371366b5fe",
202+
"reference": "138c493c5b8ee7cff3821f80b8896d371366b5fe",
203203
"shasum": ""
204204
},
205205
"require": {
@@ -210,7 +210,7 @@
210210
"psr/container": "^1.0",
211211
"symfony/phpunit-bridge": "^4.4.9|^5.0.9"
212212
},
213-
"time": "2020-10-27T19:22:48+00:00",
213+
"time": "2021-01-05T10:10:05+00:00",
214214
"type": "library",
215215
"extra": {
216216
"branch-alias": {

0 commit comments

Comments
 (0)