PHPackages                             pimssas/pims-api-client-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. pimssas/pims-api-client-php

ActiveProject[API Development](/categories/api)

pimssas/pims-api-client-php
===========================

Simple PHP client for the Pims API

1.0.0(8y ago)21.2k2[1 issues](https://github.com/pimssas/pims-api-client-php/issues)MITPHPPHP &gt;=7.0CI failing

Since Apr 17Pushed 8mo ago2 watchersCompare

[ Source](https://github.com/pimssas/pims-api-client-php)[ Packagist](https://packagist.org/packages/pimssas/pims-api-client-php)[ RSS](/packages/pimssas-pims-api-client-php/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (3)Versions (7)Used By (0)

Pims PHP API client
===================

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

Simple PHP client for the Pims API ([documentation here](http://api.pims.io)).

- [Requirement](#requirement)
- [Installation](#installation)
- [Usage](#usage)
- [License](#license)

Requirement
-----------

[](#requirement)

```
php >= 7.0

```

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

[](#installation)

Use [Composer](https://getcomposer.org/) to install. Simply add this line to your `composer.json` file:

```
"require": {
    "pimssas/pims-api-client-php": "dev-master"
}

```

and then run:

```
$ composer update
```

Or install directly from the command line:

```
$ composer require pimssas/pims-api-client-php:"dev-master"
```

Usage
-----

[](#usage)

First step, you have to create a `Client` instance:

```
use Pims\Api\Client;
use Pims\Api\Exception\ClientException;

try {
    // Minimal setup...
    $client = new Client(
            'https://demo.pims.io/api',
            'username',
            'password');

    // ... or full setup, with language and version
    $client = new Client(
            'https://demo.pims.io/api',
            'username',
            'password',
            'fr',
            'v1');
} catch (ClientException $e) {
    echo $e->getMessage();
}
```

Then you can call it on various endpoints, like this:

```
use Pims\Api\Endpoint;

try {
    // Get the label of the event by ID 2127
    $event = $client->getOne(
            Endpoint::EVENTS,
            2127);
    $label = $event->getProperty('label');

    // Get all events occuring in April 2018
    $results = $client->getAll(
            Endpoint::EVENTS,
            [
                    'from_date' => '2018-04-01',
                    'to_date'   => '2018-04-30'
            ]);
    $events = $results->getResource('events');
    while ($results->hasLink('next')) {
        $results = $client->getNext($results);
        $events = array_merge(
                $events,
                $results->getResource('events'));
    }

    // Get the first 3 channels applied to the event by ID 2127
    $promotions = $client->getAll(
            Endpoint::EVENTS_CHANNELS,
            [
                    ':event_id' => 2127,
                    'page_size' => 3
            ]);

    // Create a new streams group
    $client->postOne(
            Endpoint::STREAMS_GROUP,
            ['label' => 'Streams group test']);

    // Update the status of the promotion by ID 1437
    $client->patchOne(
            Endpoint::PROMOTIONS,
            1437,
            ['status_id' => 'ENG']);

    // Delete the venue by ID 234
    $client->deleteOne(
            Endpoint::VENUES,
            234);
} catch (ClientException $e) {
    echo $e->getMessage();
}
```

License
-------

[](#license)

Copyright (c) 2010-2019 Pims SAS. Released under the [MIT License](https://github.com/pimssas/pims-api-client-php/blob/master/LICENSE).

###  Health Score

36

—

LowBetter than 82% of packages

Maintenance33

Infrequent updates — may be unmaintained

Popularity22

Limited adoption so far

Community16

Small or concentrated contributor base

Maturity62

Established project with proven stability

 Bus Factor2

2 contributors hold 50%+ of commits

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

Unknown

Total

1

Last Release

2953d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/8e84d1936802b0b01fccdf8cf2ad385f3255eaafa922dc6e8e8cb452577b4fbc?d=identicon)[pimssas-packagist](/maintainers/pimssas-packagist)

---

Top Contributors

[![HCoignard](https://avatars.githubusercontent.com/u/17752680?v=4)](https://github.com/HCoignard "HCoignard (79 commits)")[![fvayssie](https://avatars.githubusercontent.com/u/38134103?v=4)](https://github.com/fvayssie "fvayssie (68 commits)")[![laureuh](https://avatars.githubusercontent.com/u/163847340?v=4)](https://github.com/laureuh "laureuh (18 commits)")[![dionithe](https://avatars.githubusercontent.com/u/74246833?v=4)](https://github.com/dionithe "dionithe (5 commits)")[![OrnellaSi](https://avatars.githubusercontent.com/u/41336486?v=4)](https://github.com/OrnellaSi "OrnellaSi (3 commits)")[![kris10ansn](https://avatars.githubusercontent.com/u/40371637?v=4)](https://github.com/kris10ansn "kris10ansn (1 commits)")[![pimssas-packagist](https://avatars.githubusercontent.com/u/38459906?v=4)](https://github.com/pimssas-packagist "pimssas-packagist (1 commits)")

---

Tags

Api Wrapperpims

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/pimssas-pims-api-client-php/health.svg)

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

###  Alternatives

[tencentcloud/tencentcloud-sdk-php

TencentCloudApi php sdk

3731.2M42](/packages/tencentcloud-tencentcloud-sdk-php)[fiveam-code/laravel-notion-api

Laravel Wrapper for the Notion API

435224.4k1](/packages/fiveam-code-laravel-notion-api)[marcreichel/igdb-laravel

A Laravel wrapper for version 4 of the IGDB API (Apicalypse) including webhook handling

115146.6k1](/packages/marcreichel-igdb-laravel)[otherguy/php-currency-api

A PHP API Wrapper to offer a unified programming interface for popular Currency Rate APIs.

2526.2k](/packages/otherguy-php-currency-api)[grok-php/client

Grok PHP Client is a robust and community-driven PHP client library for seamless integration with Grok AI API, offering efficient access to advanced AI and data processing capabilities.

325.9k4](/packages/grok-php-client)

PHPackages © 2026

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