PHPackages                             zendframework/zendservice-api - 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. zendframework/zendservice-api

Abandoned → [guzzle/guzzle](/?search=guzzle%2Fguzzle)ArchivedLibrary[API Development](/categories/api)

zendframework/zendservice-api
=============================

Micro framework for HTTP API client

2.0.0(9y ago)3540.2k↓50%51BSD-3-ClausePHPPHP ^5.6 || ^7.0

Since May 14Pushed 8y ago12 watchersCompare

[ Source](https://github.com/zendframework/ZendService_Api)[ Packagist](https://packagist.org/packages/zendframework/zendservice-api)[ RSS](/packages/zendframework-zendservice-api/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (1)Dependencies (3)Versions (5)Used By (1)Security (3)

zendservice-api
===============

[](#zendservice-api)

> ## Abandoned
>
> [](#abandoned)
>
> This component is abandoned and no longer maintained. We recommend using [Guzzle](http://docs.guzzlephp.org/en/stable/index.html) (which has [middleware features that enable API access](https://medium.com/@brad_brothers/build-a-better-api-client-with-guzzle-middleware-2ace56868dc7)), and/or tools built on Guzzle (e.g., [Uhura](https://github.com/colindecarlo/uhura)) that provide generic API access features.

**zendservice-api** is a micro HTTP framework to consume generic API calls in PHP. This framework can be used to create PHP libraries that consume specific HTTP API using simple configuration array (or files).

This project uses the `zend-http` component of [Zend Framework](https://framework.zend.com).

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

[](#installation)

You can install this component using [composer](http://getcomposer.org/) with following commands:

```
composer require zendframework/zendservice-api
```

Usage
-----

[](#usage)

The `ZendService\Api` component can be used to facilitate the consume of generic APIs using HTTP. This library is able to configure the header, method, body, and query string of a HTTP request according to specific API parameters.

This mapping is provided using a special PHP configuration array.

You can specify the API parameters using the `setApi` method. This method accepts two parameters: the name of the API and a closure (callback) that returns the configuration with a PHP array.

Let see an example, image you need to consume an authentication API call with a POST HTTP request using a [JSON](http://www.json.org/) data format with the following parameters: *username* and *password*.

The HTTP request can be represented as follow:

```
POST /v1/auth HTTP/1.1
Host: localhost
Connection: close
Content-Type: application/json
Content-Length: 57

{ 'auth' : { 'username' : 'admin', 'password' : 'test' }}

```

You need to configure the API call using the `setApi` method in this way (we use the `auth` name for this API):

```
use ZendService\Api\Api;

$api = new Api();
$api->setApi('auth', function ($params) {
    return array(
        'url' => 'http://localhost/v1/auth',
        'header' => array(
            'Content-Type' => 'application/json'
        ),
        'method' => 'POST',
        'body' => json_encode(array(
            'auth' => array(
                'username' => $params[0],
                'password' => $params[1]
            )
        )),
        'response' => array(
            'valid_codes' => array('200')
        )
    );
});
```

After that you can execute the API call using the function `auth` (this function is managed by the magic [\_\_call](http://php.net/manual/en/language.oop5.overloading.php#object.call)function of PHP):

```
$result = $api->auth('username', 'password');
if ($api->isSuccess()) {
    var_dump($result);
} else {
    printf("Error (%d): %s\n", $api->getStatusCode(), $api->getErrorMsg());
}
```

The mapping with the `auth` arguments and the API specification is managed using the array `$params`. You have to use the numerical index of the `$params` to match the order of the arguments in the function. Using the configuration array you can specify all the HTTP data for the API request (headers, body, uri, etc). You can also specify the HTTP status code for the successful requests using the `valid_codes` parameter in the `response` section.

Using a configuration file
--------------------------

[](#using-a-configuration-file)

You can also use a configuration file for the API calls instead of using the `setApi` method. You need to create a PHP file with the same name of the API call. This file contains the API configuration array. For instance, for the previous example you have to create a `auth.php` file containing the following array:

```
return array(
    'url' => 'http://localhost/v1/auth',
    'header' => array(
        'Content-Type' => 'application/json'
    ),
    'method' => 'POST',
    'body' => json_encode(array(
        'auth' => array(
            'username' => $params[0],
            'password' => $params[1]
        )
    )),
    'response' => array(
        'valid_codes' => array('200')
    )
);
```

You need to set the directory containing this configuration file using the `setApiPath` as follow:

```
use ZendService\Api\Api;

$api = new Api();
$api->setApiPath('path/to/api/config');
$result = $api->auth('username', 'password');
if ($api->isSuccess()) {
    var_dump($result);
} else {
    printf("Error (%d): %s\n", $api->getStatusCode(), $api->getErrorMsg());
}
```

Set the base URL for the API calls
----------------------------------

[](#set-the-base-url-for-the-api-calls)

If you need to call different API from the same base URL you can use the `setUri` function. This function set the base URL and you can use relative URI for the specific API calls, for instance imagine you need to consume an [OpenStack](https://www.openstack.org/)service with the URL , we can set this address as base URL and use relative address for each API call.

```
use ZendService\Api\Api;

$api = new Api();
$api->setUrl('http://identity.api.openstack.org');
$api->setApi('authentication', function ($params) {
    return array(
        'url' => '/v2.0/tokens',
        'header' => array(
            'Content-Type' => 'application/json'
        ),
        'method' => 'POST',
        'body' => json_encode(array(
            'auth' => array(
                'passwordCredentials' => array(
                    'username' => $params[0],
                    'password' => $params[1]
                )
            )
        )),
        'response' => array(
            'valid_codes' => array('200', '203')
        )
    );
});
$result = $api->authentication('username', 'password');
if ($api->isSuccess()) {
    printf("Authenticate!\n");
} else {
    printf("Error (%d): %s\n", $api->getStatusCode(), $api->getErrorMsg());
}
```

Note the use of the relative address in the `uri` parameter of the API configuration.

Query string in the API calls
-----------------------------

[](#query-string-in-the-api-calls)

If you need to pass a query string for an API HTTP call you can use the `setQueryParams` method of the `Api` class. For instance, imagine you need to pass the HTTP query string `?auth=strong` in the previous example, you can use the following code:

```
use ZendService\Api\Api;

$api = new Api();
$api->setQueryParams(array( 'auth' => 'strong' ));
$result = $api->authenticate('username', 'password');
if ($api->isSuccess()) {
    printf("OK!\n");
} else {
    printf("Error (%d): %s\n", $api->getStatusCode(), $api->getErrorMsg());
}
```

You can reset the query string calling the `setQueryParams()` function without a parameter.

Set the default HTTP headers
----------------------------

[](#set-the-default-http-headers)

You can specify a default HTTP headers to be used for all the HTTP calls. For instance, if you need to call a vendor API passing an authentication token using a special header field you can use this feature to set a default headers to be used for all the next API calls.

To set a default headers you can use the `setHeaders` function, below is reported an example:

```
use ZendService\Api\Api;

$api = new Api();
$api->setApiPath('path/to/api/config');
$api->setHeaders(array( 'X-Auth-Token' => 'token' ));
$result = $api->test('foo');
if ($api->isSuccess()) {
    var_dump($result);
} else {
    printf("Error (%d): %s\n", $api->getStatusCode(), $api->getErrorMsg());
}
```

The `test` API will execute a HTTP request using the headers specified in the `test.php` configuration file plus the `X-Auth-Token` header. Basically, the headers specified in the configuration file are merged with the default one specified using the `setHeaders` function. You can overwrite the default headers using the same header key in the configuration file.

###  Health Score

38

—

LowBetter than 85% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity38

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity61

Established project with proven stability

 Bus Factor1

Top contributor holds 71.4% 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 ~692 days

Total

3

Last Release

3367d ago

Major Versions

1.0.0 → 2.0.02017-02-27

PHP version history (2 changes)1.0.0beta1PHP >=5.3.3

2.0.0PHP ^5.6 || ^7.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/296074?v=4)[Zend Framework](/maintainers/zendframework)[@zendframework](https://github.com/zendframework)

---

Top Contributors

[![ezimuel](https://avatars.githubusercontent.com/u/475967?v=4)](https://github.com/ezimuel "ezimuel (25 commits)")[![weierophinney](https://avatars.githubusercontent.com/u/25943?v=4)](https://github.com/weierophinney "weierophinney (8 commits)")[![corleroux](https://avatars.githubusercontent.com/u/1222371?v=4)](https://github.com/corleroux "corleroux (1 commits)")[![samsonasik](https://avatars.githubusercontent.com/u/459648?v=4)](https://github.com/samsonasik "samsonasik (1 commits)")

---

Tags

apizendZend Framework

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/zendframework-zendservice-api/health.svg)

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

###  Alternatives

[m165437/laravel-blueprint-docs

API Blueprint Renderer for Laravel

22779.0k](/packages/m165437-laravel-blueprint-docs)[evandotpro/edp-github

Github API integration module for Zend Framework 2

241.6k](/packages/evandotpro-edp-github)

PHPackages © 2026

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