PHPackages                             neoption/redmine-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. neoption/redmine-api

ActiveLibrary[API Development](/categories/api)

neoption/redmine-api
====================

Redmine API client

v1.6.0(7y ago)04MITPHPPHP ^5.4 || ^7.0

Since Oct 8Pushed 7y ago3 watchersCompare

[ Source](https://github.com/neoption/php-redmine-api)[ Packagist](https://packagist.org/packages/neoption/redmine-api)[ Docs](https://github.com/neoption/php-redmine-api)[ RSS](/packages/neoption-redmine-api/feed)WikiDiscussions master Synced today

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

PHP Redmine API
===============

[](#php-redmine-api)

A simple Object Oriented wrapper for Redmine API, written with PHP5.

Uses [Redmine API](http://www.redmine.org/projects/redmine/wiki/Rest_api/).

Features
--------

[](#features)

- Follows PSR-0 conventions and coding standard: autoload friendly
- API entry points implementation state :
- OK Attachments
- OK Groups
- OK Custom Fields
- OK Issues
- OK Issue Categories
- OK Issue Priorities
- *NOK Issue Relations - only partially implemented*
- OK Issue Statuses
- OK News
- OK Projects
- OK Project Memberships
- OK Queries
- OK Roles
- OK Time Entries
- OK Time Entry Activities
- OK Trackers
- OK Users
- OK Versions
- OK Wiki

Todo
----

[](#todo)

- Check header's response code (especially for POST/PUT/DELETE requests)
- See
- Maybe Guzzle for handling http connections
-

Limitations
-----------

[](#limitations)

Redmine is missing some APIs for a full remote management of the data :

- List of activities & roles :
- ...

A possible solution to this would be to create an extra APIs implementing the missing entry points. See existing effort in doing so :

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

[](#requirements)

- PHP >= 5.4
- The PHP [cURL](http://php.net/manual/en/book.curl.php) extension
- The PHP [SimpleXML](http://php.net/manual/en/book.simplexml.php) extension
- The PHP [JSON](http://php.net/manual/en/book.json.php) extension
- [PHPUnit](https://phpunit.de/) >= 4.0 (optional) to run the test suite
- "Enable REST web service" for your Redmine project (/settings/edit?tab=authentication)
- then obtain your *API access key* in your profile page : /my/account
- or use your *username & password*

Install
-------

[](#install)

### Composer

[](#composer)

[Composer](http://getcomposer.org/download/) users can simply run:

```
$ php composer.phar require kbsali/redmine-api:~1.0
```

at the root of their projects. To utilize the library, include Composer's `vendor/autoload.php` in the scripts that will use the `Redmine` classes.

For example,

```