HostBill User API plugin enables HTTP REST API for your customers to manage their accounts from their apps/systems. Additionally API is self-documenting so your users will have nice, comprehensive documentation of all methods that your API offers.
Path to JSON Web Token key - used with JSON Web token auth.
Path to RSA private key file, relative to hostbill installation directory or an absolute path.
ssh-keygen -t rsa -b 4096 -m PEM -f private.key -q -N "" |
Nginx (including HostBill enterprise) users .
If you are using SEO URL rewrites described here, modify block "@seohburl" in /etc/nginx/locations/hostbill.conf to look like:
location @seohburl { rewrite ^/api/(.+)$ /api/index.php?/$1 last; rewrite ^/(.+)$ /index.php?/$1 last; } |
If you are not using SEO urls, edit your location file (in server section, for HostBill enterprise it is /etc/nginx/locations/hostbill.conf, add
location @userapi { rewrite ^/api/(.+)$ /api/index.php?/$1 last; } |
Next, to main location add try files line:
try_files $uri $uri/ @userapi; |
Now, restart your webserver.
You can configure routes (API functions) in Adminarea → Extras → User API
Using this section, you can:
Change route name - change how route appears in documentation
Change route category - change category where route appears in documentation
Change route description - enter your custom description of route to be shown in documentation
User API module allows you to log queries. Logging is optional and can be activated from the module configuration.
After activation, a new User API Log section will be available on the module page. In this section, you can see the date, method, route, in/out data, the IP address and the user who sent the query.
FAQ
Question: Can we customize client area templates, edit introduction text or add company logo?
Answer: Yes, but you will need to edit template files used by this module, located in: ./includes/modules/Other/userapi/user/
Question: I'm missing route/function XYZ, do you plan to add it?
Answer: Yes! Just let us know what is missing for you and we're happy to improve this plugin for you.
Question: I'm using Apache + PHP-FPM - I'm always getting wronglogin error, even with right credentials.
Answer: Your apache is not passing Authorization header to php-fpm. To do that, add to your .htaccess or vhost config file:
SetEnvIf Authorization "(.*)" HTTP_AUTHORIZATION=$1 |