PHPackages                             ominity/ominity-api-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. ominity/ominity-api-php

ActiveLibrary[API Development](/categories/api)

ominity/ominity-api-php
=======================

Ominity API library for PHP.

v1.3.2(4mo ago)02.0k1BSD-2-ClausePHPPHP ^7.2|^8.0

Since Aug 22Pushed 4mo agoCompare

[ Source](https://github.com/ominity/ominity-api-php)[ Packagist](https://packagist.org/packages/ominity/ominity-api-php)[ Docs](https://www.ominity.com/)[ RSS](/packages/ominity-ominity-api-php/feed)WikiDiscussions main Synced 1mo ago

READMEChangelog (10)Dependencies (6)Versions (43)Used By (1)

Ominity API client for PHP
==========================

[](#ominity-api-client-for-php)

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

[](#requirements)

To use the Ominity API client, the following things are required:

- PHP >= 7.0
- Up-to-date OpenSSL (or other SSL/TLS toolkit)

Installation
------------

[](#installation)

### Using Composer

[](#using-composer)

The easiest way to install the Ominity API client is by using [Composer](http://getcomposer.org/doc/00-intro.md). You can require it with the following command:

```
composer require ominity/ominity-api-php
```

### Manual Installation

[](#manual-installation)

If you're not familiar with using composer we've added a ZIP file to the releases containing the API client and all the packages normally installed by composer. Download the `ominity-api-php.zip` from the [releases page](https://github.com/ominity/ominity-api-php/releases).

Include the `vendor/autoload.php`

Usage
-----

[](#usage)

Initializing the Ominity API client, and setting your endpoint and API key.

```
$ominity = new \Ominity\Api\OminityApiClient();
$ominity->setApiEndpoint("https://ominity.example.com/api");
$ominity->setApiKey("q48fd94qs98fd4sqf89fza9sqd89f4");
```

With the `OminityApiClient` you can now access any of the following endpoints by selecting them as a property of the client:

### Enabling debug mode

[](#enabling-debug-mode)

When troubleshooting, it can be highly beneficial to have access to the submitted request within the `ApiException`. To safeguard against inadvertently exposing sensitive request data in your local application logs, the debugging feature is initially turned off.

To enable debugging and inspect the request:

```
/** @var $ominity \Ominity\Api\OminityApiClient */
$ominity->enableDebugging();

try {
    $ominity->commerce->products->get(1);
} catch (\Ominity\Api\Exceptions\ApiException $exception) {
    $request = $exception->getRequest();
}
```

If you are recording instances of `ApiException`, the request details will be included in the logs. It is vital to ensure that no sensitive information is retained within these logs and to perform cleanup after debugging is complete.

To disable debugging again:

```
/** @var $ominity \Ominity\Api\OminityApiClient */
$ominity->disableDebugging();
```

License
-------

[](#license)

[BSD (Berkeley Software Distribution) License](https://opensource.org/licenses/bsd-license.php). Copyright (c) 2024, Ominity

###  Health Score

43

—

FairBetter than 91% of packages

Maintenance77

Regular maintenance activity

Popularity17

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity57

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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 ~12 days

Recently: every ~54 days

Total

42

Last Release

124d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/7924ffc05230e682beedd22b0644fc1f80e78e79dd285bbacad764cf9fbb7649?d=identicon)[ominity](/maintainers/ominity)

---

Top Contributors

[![timdesm](https://avatars.githubusercontent.com/u/30378686?v=4)](https://github.com/timdesm "timdesm (126 commits)")

###  Code Quality

TestsPHPUnit

Static AnalysisPHPStan

Code StylePHP CS Fixer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/ominity-ominity-api-php/health.svg)

```
[![Health](https://phpackages.com/badges/ominity-ominity-api-php/health.svg)](https://phpackages.com/packages/ominity-ominity-api-php)
```

###  Alternatives

[maxmind/web-service-common

Internal MaxMind Web Service API

29783.1M2](/packages/maxmind-web-service-common)[mollie/mollie-api-php

Mollie API client library for PHP. Mollie is a European Payment Service provider and offers international payment methods such as Mastercard, VISA, American Express and PayPal, and local payment methods such as iDEAL, Bancontact, SOFORT Banking, SEPA direct debit, Belfius Direct Net, KBC Payment Button and various gift cards such as Podiumcadeaukaart and fashioncheque.

59914.4M62](/packages/mollie-mollie-api-php)[firstred/postnl-api-php

PostNL REST API PHP Bindings

27610.2k1](/packages/firstred-postnl-api-php)[mhujer/fio-api-php

Fio API PHP implemention

37199.1k1](/packages/mhujer-fio-api-php)[mvdnbrk/dhlparcel-php-api

DHL Parcel API client for PHP

3957.9k5](/packages/mvdnbrk-dhlparcel-php-api)[optiosteam/payconiq-client-php

Payconiq API client library for PHP developed by Optios.

1273.4k](/packages/optiosteam-payconiq-client-php)

PHPackages © 2026

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