Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.


  1. If the plugin is included in your HostBill edition you can download it from your client portal.
  2. If the plugin is not included in your HostBill edition you can purchase it from our marketplace and then download it from the client area.
  3. Once you download the plugin extract it in the main HostBill directory.
  4. Go to Settings → Modules, find and activate User API plugin.

Module configuration


Image Added

  1. Proceed to Extras → User API - you can manage your API routes from this sectionAPI where you can:
    1. Enable/disable logging. Enable only for debug/testing purposes
    2. Set Rate limit -  Number of requests users can make in a period of time, when exceeded new requests will be discarded.
    3. Select available Authentication methods:
      1. Basic HTTP Auth - This option enables client to use basic authentication. It requires client login credentials in every api request.
      2. JSON Web Token Auth - Allows clients to authenticate requests with generated token. Client will need to pass their credentials to /login route to generate required token.
    4. 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.

      Code Block
      titleGenerating private key in linux
      ssh-keygen -t rsa -b 4096 -m PEM -f private.key -q -N ""

  2. It is important to set URL rewrites for API to function, depending on your web-server software
    1. Apache users
      in /api folder rename file template.htaccess to .htaccess 
    2. 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:

      Code Block
      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 

      Code Block
      location @userapi {
            rewrite ^/api/(.+)$ /api/index.php?/$1 last;

      Next, to main location add try files line:

      Code Block
      try_files $uri $uri/ @userapi;

  3. Now, restart your webserver.