PHPackages                             leuchtdiode/pimcore-rest-api-zf3 - 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. leuchtdiode/pimcore-rest-api-zf3

Abandoned → [leuchtdiode/laminas-pimcore-rest-api](/?search=leuchtdiode%2Flaminas-pimcore-rest-api)ArchivedLibrary[API Development](/categories/api)

leuchtdiode/pimcore-rest-api-zf3
================================

Zend Framework 3 module for accessing pimcore via its REST API

0.1.4(7y ago)041MITPHPPHP >=7.1

Since Oct 25Pushed 7y ago1 watchersCompare

[ Source](https://github.com/leuchtdiode/pimcore-rest-api-zf3)[ Packagist](https://packagist.org/packages/leuchtdiode/pimcore-rest-api-zf3)[ Docs](https://github.com/leuchtdiode/pimcore-rest-api-zf3)[ RSS](/packages/leuchtdiode-pimcore-rest-api-zf3/feed)WikiDiscussions master Synced 2d ago

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

pimcore (REST API) module for Zend Framework 3
==============================================

[](#pimcore-rest-api-module-for-zend-framework-3)

Zend Framework 3 module for accessing [pimcore](https://github.com/pimcore/pimcore) via its REST API.

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

[](#installation)

Installation of this module uses composer. For composer documentation, please refer to [getcomposer.org](http://getcomposer.org/).

```
php composer.phar require leuchtdiode/pimcore-rest-api
```

Then add `PimcoreRestApi` to your `config/application.config.php`.

Usage
-----

[](#usage)

Currently there are the following features included:

- Retrieve document by ID
- Retrieve document by its path
- Search documents
- A view helper to print freetext of a document

### Set up

[](#set-up)

In order to use the API, you have to specify a config set `pimcoreRestApi` somewhere in your application (e.g. `config/autoload/local.php`)

You have to set the following parameters:

- `host`: The host where your pimcore API resides (e.g. cms.company.com)
- `ssl`: Defaults to false. Setting it to true will request API through SSL. (e.g. )
- `apiKey`: The API-Key you generated in pimcore for your user

For example:

```