Skip to content
Alexander Saal edited this page Aug 7, 2025 · 3 revisions

Introduction

What is the JobRouter® PHP SDK?

The SDK is a reliable foundation for developing custom applications and extensions for JobRouter®.

It provides well-structured interfaces, comprehensive documentation, and practical examples to streamline your development process. By using the SDK, you gain direct access to essential JobRouter® functionality — such as data management, user information, and configuration settings — while ensuring consistency and maintainability across your integrations.

Purpose of the JobRouter® PHP SDK

The SDK is not intended to replace existing APIs such as the REST API or specialized interfaces like the Dashboard API, System activity API or (Workflow) PHP API. Instead, it provides a lightweight and efficient way to access core functionality of JobRouter® directly from within a custom application running on the same server.

This eliminates the overhead and latency of external API calls and is ideal for generic or cross-functional use cases that go beyond the more narrowly defined scopes of other APIs.

Example Use Cases for the JobRouter® PHP SDK

Custom Applications can be anything that adds additional functionality or value to JobRouter® as a workspace itself or to specific workflows. Example use cases could be:

  • a vacation or event calendar accessing workflow data from HR or Marketing processes
  • a profile page or personnel file for users in JobRouter®
  • any kind of web page that is shown somewhere in JobRouter® and requires access to JobRouter® data
  • ajax endpoints used to fetch data for dialogs
  • ajax endpoints for interactive dashboard widgets1

Intended Users for the JobRouter® PHP SDK

The SDK is intended for developers with a solid understanding of PHP, including concepts such as closures and dependency injection.

While deep expertise or years of experience are not required, users should be comfortable working with modern PHP development patterns in order to build and maintain custom applications effectively.


1: The official Dashboard API only supports static widgets. If interaction and data exchange with the server is required, the endpoint could be created using the SDK.

Clone this wiki locally