OPNsense Forum

English Forums => Development and Code Review => Topic started by: soif on January 12, 2024, 06:19:37 pm

Title: HackApi for OPNsense - php API client
Post by: soif on January 12, 2024, 06:19:37 pm

Hi folks,

Just to let you know that i've just released HackApi, a php API client , with an OPNsense module.
https://github.com/soif/HackApi/ (https://github.com/soif/HackApi/)

It currently implements 658 methods (https://github.com/soif/HackApi/tree/master/src/devices/opnsense) to interface with the OPNsense API.
I've successfully tested over 250 methods (endpoints) that are now production ready.

If you like this library, you're more than welcome to test and report untested methods and/or add missing descriptions. Pull Requests are always welcome!

FYI this API client also implements modules for openWRT, Huawei or ZTE modems, and SFR (isp) boxes....
Feel free to add your own, if you like.

Happy new year!

Title: Re: HackApi for OPNsense - php API client
Post by: alexdelprete on January 31, 2024, 04:52:18 pm

This is really interesting. I'm collaborating on this project to integrate OPNsense in Home Assistant: https://github.com/travisghansen/hass-opnsense/

It uses both REST API and XMLrpc because the API doesn't offer everything needed. I wonder if using your library we could cover everything.

I'll tell Travis, the dev, about this so he can take a look and see if it fits well. :)

Thanks a lot.

Title: Re: HackApi for OPNsense - php API client
Post by: soif on February 07, 2024, 11:59:16 am

Thank you  8)

I've just replied in your Github issue...

https://github.com/soif/HackApi/issues/1