PHPackages                             paipe/phpclient - 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. [Utility & Helpers](/categories/utility)
4. /
5. paipe/phpclient

ActiveLibrary[Utility & Helpers](/categories/utility)

paipe/phpclient
===============

Paipe data

v1.0.3(3y ago)11.3kPHP

Since May 18Pushed 3y ago2 watchersCompare

[ Source](https://github.com/paipedata/php-client)[ Packagist](https://packagist.org/packages/paipe/phpclient)[ RSS](/packages/paipe-phpclient/feed)WikiDiscussions main Synced 1mo ago

READMEChangelogDependencies (6)Versions (5)Used By (0)

Paipe API Client for PHP
========================

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

Paipe PHP client provides an easy interface for Feba data services, it handles authentication from Paipe Auth, pre-authorize services and validate authorized actions.

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

[](#installation)

```
composer require paipe/phpclient

```

Usage
-----

[](#usage)

Firstly get instantiate a client then get a service from it. In this example, we're going to use the config:

- `aaaUrl` the Auth endpoint as `https://auth.paipe.com.br`
- `appKey` the app key as `app-key`
- `appSecret` the app secret as `app-secret`

In order to get the client done, above parameter should be shared to the application.

Example to perform GET with query string:

```
$client = new paipe\phpclient\Client([
  'aaaUrl' => 'https://auth.paipe.com.br',
  'appKey' => 'app-key',
  'appSecret' => 'app-secret'
];

$response = $client->getService('cep')->request('GET' '/lookup', [
    'query' => ['keyword' => 'av paulista']
]);
```

The response comes as [Psr\\Http\\Message\\MessageInterface](https://github.com/php-fig/http-message/blob/master/docs/PSR7-Interfaces.md#psrhttpmessagemessageinterface-methods), then you call common functions and the `$options` parameter are same as [GuzzleHttp\\RequestOptions](https://docs.guzzlephp.org/en/stable/request-options.html)

To post to data service as json:

```
$service = $client->getService('postal-code')
$resp = $service->request('POST' '/search', [
    'json' => ['foo' => 'data']
]);
```

Injecting a custom header:

```
$service = $client->getService('postal-code')
$resp = $service->request('POST' '/search', [
    'headers' => ['X-My-Header' => 'nice header'],
    'json' => ['foo' => 'data']
]);
```

© [Paipe](https://www.paipe.com.br/)

###  Health Score

29

—

LowBetter than 59% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity20

Limited adoption so far

Community10

Small or concentrated contributor base

Maturity55

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 93.8% 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 ~190 days

Total

3

Last Release

1447d ago

### Community

Maintainers

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

---

Top Contributors

[![shairontoledo](https://avatars.githubusercontent.com/u/22649?v=4)](https://github.com/shairontoledo "shairontoledo (15 commits)")[![jessemota](https://avatars.githubusercontent.com/u/6887580?v=4)](https://github.com/jessemota "jessemota (1 commits)")

###  Code Quality

TestsCodeception

Static AnalysisPHPStan

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/paipe-phpclient/health.svg)

```
[![Health](https://phpackages.com/badges/paipe-phpclient/health.svg)](https://phpackages.com/packages/paipe-phpclient)
```

###  Alternatives

[shlinkio/shlink

A self-hosted and PHP-based URL shortener application with CLI and REST interfaces

4.8k4.3k](/packages/shlinkio-shlink)[ralphjsmit/laravel-helpers

A package containing handy helpers for your Laravel-application.

13704.6k2](/packages/ralphjsmit-laravel-helpers)[dhlparcel/magento2-plugin

DHL Parcel plugin for Magento 2

11180.5k2](/packages/dhlparcel-magento2-plugin)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

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