AppApi-Module that adds a file endpoint

AppApiFile adds the /file endpoint to the AppApi routes definition. Makes it possible to query files via the api.

Current Version Current Version Current Version

Buy Me A Coffee

Relies on AppApi:

AppApiFile relies on the base module AppApi, which must be installed before AppApiFile can do its work.

AppApi and AppApiFile can be installed like every other module in ProcessWire. Check the following guide for detailed information: How-To Install or Uninstall Modules

The prerequisites are PHP>=7.2.0 and a ProcessWire version >=3.93.0 (+ AppApi>=1.2.0). However, this is also checked during the installation of the module. No further dependencies.

You can access all files that are uploaded at any ProcessWire page. Call /file/route/in/pagetree?file=test.jpg to access a page via its route in the page tree. Alternatively you can call /file/4242?file=test.jpg (e.g.,) to access a page by its id. The module will make sure that the page is accessible by the active user.

The GET-param "file" defines the basename of the file which you want to get.

The following GET-params (optional) can be used to manipulate an image:

widthint >= 0Width of the requested image
heightint >= 0Height of the requested image
maxWidthint >= 0Maximum Width, if the original image's resolution is sufficient
maxHeightint >= 0Maximum Height, if the original image's resolution is sufficient
cropXint >= 0Start-X-position for cropping (crop enabled, if width, height, cropX & cropY set)
cropYint >= 0Start-Y-position for cropping (crop enabled, if width, height, cropX & cropY set)

Use GET-Param format=base64 to receive the file in base64 format.

Pro tip: If you want to include an image from the api using the standard <img src=""> tag, it can be very difficult to include the api key and a token as headers. However, it is possible to include these values as GET parameters. The GET parameter with the apikey is called api_key. A token can be sent as parameter authorization.

Disclaimer: I recommend to use this solution only for this exceptional case. Generally headers are the better and more elegant solution.

  • Bugfix throw 404 status if not found
  • Fix Webp support
  • Added support for Multi-Language URLS
  • Improved access to repeater images
  • Updated module infos
  • Smaller improvements in README
  • Added file endpoint
  • implemented different ways to access a page
  • implemented image-manipulation parameters

We use SemVer for versioning. For the versions available, see the tags on this repository.

This project is licensed under the Mozilla Public License Version 2.0 - see the file for details.

Install and use modules at your own risk. Always have a site and database backup before installing new modules.

Latest news

  • ProcessWire Weekly #489
    In the 489th issue of ProcessWire Weekly we'll check out what's new in the core this week, share a brand-new recipe of the week, and more. Read on! / 23 September 2023
  • ProcessWire 3.0.226 new main/master version
    After 8 months in development we are excited to bring you ProcessWire 3.0.226 main/master. This version has a ton of great new features, improvements and optimizations, plus more than 100 issue fixes. This post takes an in-depth look at highlights from this great new version.
    Blog / 25 August 2023
  • Subscribe to weekly ProcessWire news

“To Drupal, or to ProcessWire? The million dollar choice. We decided to make an early switch to PW. And in retrospect, ProcessWire was probably the best decision we made. Thanks are due to ProcessWire and the amazing system and set of modules that are in place.” —Unni Krishnan, Founder of PigtailPundits