Difference between revisions of "API"
| Line 1: | Line 1: | ||
This is community documentation for the API. To see official documentation, review zoneminder.readthedocs.org | This is community documentation for the API. To see official documentation, review zoneminder.readthedocs.org | ||
== | ==Test API is Working (1.32+)== | ||
Use this command | Use this command if you've enabled authentication. | ||
curl -X POST -d "user=somename&pass=somepass" http://serverip/zm/api/host/getVersion.json | curl -X POST -d "user=somename&pass=somepass" http://serverip/zm/api/host/getVersion.json | ||
Make sure all of this is included. It is not necessary to use login.json before running this command. The ampersand must be between user and pass. | Make sure all of this is included. It is not necessary to use login.json before running this command. The ampersand must be between user and pass. If you aren't using authentication then use the following: | ||
curl -X GET http://serverip/zm/api/host/getVersion.json | |||
==SSL Configuration== | ==SSL Configuration== | ||
| Line 17: | Line 18: | ||
You may optionally want to generate a new SSL key. | You may optionally want to generate a new SSL key. | ||
Setting up self signed SSL certs for apache2 is a common sysadmin task. Search online for more info. | Setting up self signed SSL certs for apache2 is a common sysadmin task that will not be covered in this guide. Search online for more info. | ||
==Configuring CakePHP for "insertwebserverhere"== | |||
Having recently setup the API for lighttpd, I found the following was necessary in order to get | |||
it to work properly. Maybe this information will assist someone else who isn't using Apache / Nginx / Lighttpd as | |||
the configuration should be similar for any webserver that supports PHP, aliases and rewrites. | |||
First off the webroot for zm may look something like this: | |||
[[Category:Dummies_Guide]] | [[Category:Dummies_Guide]] | ||
Revision as of 21:53, 4 November 2022
This is community documentation for the API. To see official documentation, review zoneminder.readthedocs.org
Test API is Working (1.32+)
Use this command if you've enabled authentication.
curl -X POST -d "user=somename&pass=somepass" http://serverip/zm/api/host/getVersion.json
Make sure all of this is included. It is not necessary to use login.json before running this command. The ampersand must be between user and pass. If you aren't using authentication then use the following:
curl -X GET http://serverip/zm/api/host/getVersion.json
SSL Configuration
Related to the API, if you wish to have some encryption, refer to /etc/apache2/ports.conf You will see that it requires the ssl module, and the symbolic link.
a2enmod ssl
Add the symbolic link for /etc/apache2/sites-available/default-ssl.conf to sites-enabled.
And uncomment / enable SSLEngine, SSLCertificateKey, and SSLCertificateKeyFile in /etc/apache2/sites-available/default-ssl.conf.
You may optionally want to generate a new SSL key.
Setting up self signed SSL certs for apache2 is a common sysadmin task that will not be covered in this guide. Search online for more info.
Configuring CakePHP for "insertwebserverhere"
Having recently setup the API for lighttpd, I found the following was necessary in order to get it to work properly. Maybe this information will assist someone else who isn't using Apache / Nginx / Lighttpd as the configuration should be similar for any webserver that supports PHP, aliases and rewrites.
First off the webroot for zm may look something like this:
