PHPackages                             jwread/olivetin-bindings-php - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [API Development](/categories/api)
4. /
5. jwread/olivetin-bindings-php

ActiveLibrary[API Development](/categories/api)

jwread/olivetin-bindings-php
============================

PHP client for the OliveTin Connect RPC API — start actions with bearer API-key style credentials

1.1.0(2w ago)03[1 PRs](https://github.com/OliveTin/OliveTin-bindings-php/pulls)Apache-2.0PHPPHP >=8.1CI passing

Since May 21Pushed 1w agoCompare

[ Source](https://github.com/OliveTin/OliveTin-bindings-php)[ Packagist](https://packagist.org/packages/jwread/olivetin-bindings-php)[ RSS](/packages/jwread-olivetin-bindings-php/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (2)Dependencies (3)Versions (10)Used By (0)

OliveTin PHP API client
=======================

[](#olivetin-php-api-client)

Small PHP bindings for the [OliveTin](https://github.com/OliveTin/OliveTin) **Connect RPC** HTTP JSON API. Supported calls include **`Init`** (connection and auth check), plus **starting actions** (fire-and-forget and wait-for-completion).

Links
-----

[](#links)

- **[Packagist package](https://packagist.org/packages/jwread/olivetin-bindings-php)** — Composer metadata and releases
- **[OliveTin (upstream)](https://github.com/OliveTin/OliveTin)** — main OliveTin server repository

Requirements
------------

[](#requirements)

- PHP 8.1+
- Extensions: `json`, `curl`

Install
-------

[](#install)

From the repository root containing `php/`:

```
composer require jwread/olivetin-bindings-php
```

Or add a path repository pointing at `./php` and require it locally (`jwread/olivetin-bindings-php:@dev`).

Authentication
--------------

[](#authentication)

This client supports **one** credential style: an HTTP bearer token sent as:

```
Authorization: Bearer
```

How OliveTin interprets that token depends on your server configuration:

- With **JWT** auth (`authJwtHmacSecret`, JWKS, or a public key), pass a valid JWT string as the token (still sent as `Bearer`).
- With **trusted reverse proxies**, validate your own API key at the proxy and translate successful requests into headers OliveTin trusts (`authHttpHeaderUsername`, etc.). In that setup your PHP code might still send `Bearer ` to the proxy only—never expose OliveTin directly without TLS and proper validation.

OAuth flows, cookies, and local username/password login are intentionally **not** implemented here.

Usage
-----

[](#usage)

Base URL should be the OliveTin web root (same host/port as the UI), **without** the `/api` suffix—the client adds `/api` by default.

```