PHPackages                             0ctobat/octobat-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. 0ctobat/octobat-php

ActiveLibrary[API Development](/categories/api)

0ctobat/octobat-php
===================

Octobat PHP Library

2.4.0(5y ago)455.0k↓33.3%4[2 issues](https://github.com/0ctobat/octobat-php/issues)MITPHPPHP >=5.4.0CI failing

Since May 2Pushed 5y ago4 watchersCompare

[ Source](https://github.com/0ctobat/octobat-php)[ Packagist](https://packagist.org/packages/0ctobat/octobat-php)[ Docs](https://www.octobat.com/)[ RSS](/packages/0ctobat-octobat-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (8)Dependencies (3)Versions (9)Used By (0)

Octobat PHP bindings
====================

[](#octobat-php-bindings)

You can sign up for an Octobat account at .

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

[](#requirements)

PHP 5.4.0 and later.

Composer
--------

[](#composer)

You can install the bindings via [Composer](http://getcomposer.org/). Run the following command:

```
composer require 0ctobat/octobat-php
```

To use the bindings, use Composer's [autoload](https://getcomposer.org/doc/01-basic-usage.md#autoloading):

```
require_once('vendor/autoload.php');
```

Manual Installation
-------------------

[](#manual-installation)

If you do not wish to use Composer, you can download the [latest release](https://github.com/0ctobat/octobat-php/releases). Then, to use the bindings, include the `init.php` file.

```
require_once('/path/to/octobat-php/init.php');
```

Dependencies
------------

[](#dependencies)

The bindings require the following extensions in order to work properly:

- [`curl`](https://secure.php.net/manual/en/book.curl.php), although you can use your own non-cURL client if you prefer
- [`json`](https://secure.php.net/manual/en/book.json.php)
- [`mbstring`](https://secure.php.net/manual/en/book.mbstring.php) (Multibyte String)

If you use Composer, these dependencies should be handled automatically. If you install manually, you'll want to make sure that these extensions are available.

Getting Started
---------------

[](#getting-started)

Simple usage looks like:

```
\Octobat\Octobat::setApiKey('sk_test_BQokikJOvBiI2HlWgH4olfQ2');
$customer = \Octobat\Customer::create(['email' => "john.doe@gmail.com", 'name' => 'John Doe', 'billing_address_country' => 'FR']);
echo $customer;
```

Documentation
-------------

[](#documentation)

Please see  for up-to-date documentation.

### Configuring a Logger

[](#configuring-a-logger)

The library does minimal logging, but it can be configured with a \[`PSR-3` compatible logger\]\[psr3\] so that messages end up there instead of `error_log`:

```
\Octobat\Octobat::setLogger($logger);
```

### Per-request Configuration

[](#per-request-configuration)

For apps that need to use multiple keys during the lifetime of a process, it's also possible to set a per-request key and/or account:

```
\Octobat\Customer::all([], [
    'api_key' => 'oc_test_skey...'
]);

\Octobat\Customer::retrieve("oc_cu_xxxxxxxx", [
    'api_key' => 'oc_test_skey...'
]);
```

###  Health Score

34

—

LowBetter than 77% of packages

Maintenance10

Infrequent updates — may be unmaintained

Popularity34

Limited adoption so far

Community14

Small or concentrated contributor base

Maturity63

Established project with proven stability

 Bus Factor1

Top contributor holds 50% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~157 days

Recently: every ~82 days

Total

8

Last Release

1838d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/7717179?v=4)[Octobat](/maintainers/Octobat)[@Octobat](https://github.com/Octobat)

---

Top Contributors

[![zuuno](https://avatars.githubusercontent.com/u/2089978?v=4)](https://github.com/zuuno "zuuno (2 commits)")[![timodwhit](https://avatars.githubusercontent.com/u/2761203?v=4)](https://github.com/timodwhit "timodwhit (1 commits)")[![vojtech-dobes](https://avatars.githubusercontent.com/u/415925?v=4)](https://github.com/vojtech-dobes "vojtech-dobes (1 commits)")

---

Tags

apioctobat

###  Code Quality

TestsPHPUnit

Code StylePHP\_CodeSniffer

### Embed Badge

![Health badge](/badges/0ctobat-octobat-php/health.svg)

```
[![Health](https://phpackages.com/badges/0ctobat-octobat-php/health.svg)](https://phpackages.com/packages/0ctobat-octobat-php)
```

###  Alternatives

[m165437/laravel-blueprint-docs

API Blueprint Renderer for Laravel

22779.0k](/packages/m165437-laravel-blueprint-docs)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)