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:

Installation


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.

Features


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:

ParamValueDescription
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.

Changelog


Changes in 1.0.6 (2022-06-01)

  • Bugfix throw 404 status if not found

Changes in 1.0.5 (2022-05-30)

  • Fix Webp support

Changes in 1.0.4 (2022-04-29)

  • Added support for Multi-Language URLS

Changes in 1.0.3 (2021-10-31)

  • Improved access to repeater images

Changes in 1.0.2 (2021-10-23)

  • Updated module infos

Changes in 1.0.1 (2021-10-23)

  • Smaller improvements in README

Changes in 1.0.0 (2021-10-21)

  • Added file endpoint
  • implemented different ways to access a page
  • implemented image-manipulation parameters

Versioning


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

License


This project is licensed under the Mozilla Public License Version 2.0 - see the LICENSE.md 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 #515
    In the 515th issue of ProcessWire Weekly we’ll check out the latest core updates, new modules, and more. Read on!
    Weekly.pw / 23 March 2024
  • Invoices Site Profile
    The new invoices site profile is a free invoicing application developed in ProcessWire. It enables you to create invoices, record payments to them, email invoices to clients, print invoices, and more. This post covers all the details.
    Blog / 15 March 2024
  • Subscribe to weekly ProcessWire news

“The end client and designer love the ease at which they can update the website. Training beyond how to log in wasn’t even necessary since ProcessWire’s default interface is straightforward.” —Jonathan Lahijani