AppApi

Connect your apps to ProcessWire CMS!

This module helps you to create an api, to which an app or an external service can connect to.

A special thanks goes to Thomas Aull , whose module RestApi was the starting point to this project.

Credits: go to Benjamin Milde for his code example on how to use FastRoute with ProcessWire and Camilo Castro for this Gist

<a href='https://ko-fi.com/E1E2LOEPF' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi3.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>

| | | | ------------------: | -------------------------------------------------------------------------- | | ProcessWire-Module: | https://modules.processwire.com/modules/app-api/ | | Support-Forum: | https://processwire.com/talk/topic/24014-new-module-appapi/ | | Repository: | https://github.com/Sebiworld/AppApi | | Wiki: | https://github.com/Sebiworld/AppApi/wiki | | | |

<a name="features"></a>

Features

• Simple routing definition
• Authentication - Three different authentication-mechanisms are ready to use.
• Access-management via UI
• Multiple different applications with unique access-rights and authentication-mechanisms can be defined

Table of Contents

• 1: Home, Installation & Quickstart
  • FAQ
  • Changelog
  • Module Configuration
• 2: Defining Applications
  • 2.1: Api-Keys
  • 2.2: PHP-Session (Recommended for on-site usage)
  • 2.3: Single JWT (Recommended for external server-calls)
  • 2.4: Double JWT (Recommended for apps)
• 3: Creating Endpoints
  • 3.1: Output Formatting
  • 3.2: Error Handling
  • 3.3: Example: Listing Users
  • 3.4: Add Documentation
• 4: AppApi Modules

<a name="installation"></a>

Installation

AppApi 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. However, this is also checked during the installation of the module. No further dependencies.

<a name="faq"></a>

FAQ

Are you having problems or just don't know what to do? Take a look at the frequently asked questions! Many questions have already been answered in the ProcessWire forum, and of course someone there is always happy to help.

<a name="app-api-modules"></a>

AppApi Modules

Since version 1.2.0 it is possible to install AppApi modules that provide their own route handlers without having to change anything in Routes.php.

Here is a list of the currently available AppApi modules.

<a name="changelog"></a>

Changelog

A detailed description of the changes per version can be found here: Changelog

<a name="versioning"></a>

Versioning

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

<a name="license"></a>

License

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

---

:arrow_right: Continue with 2: Defining Applications