FreeScript
php-redmine-api
by kbsali · version 2026.11.13 · updated 2 days ago
No reviews yet
- Downloads
- 0
- Reviews
- 0
- Size
- 100 KB
- Code check
- Clean
- Licence
- MIT
- Released
- Nov 2026
A simple PHP Redmine API client, Object Oriented
PHP Redmine API
A simple PHP Object Oriented wrapper for Redmine API.
Uses Redmine API.
Features
like Guzzle for handling http connections
Supported Redmine versions
We support (and run tests against) the latest supported Redmine versions
that receive security updates.
php-redmine-api, 7.0, 6.1, 6.0, 5.1, 5.0, 4.2
v2.11, ✅, ✅, ✅, ✅, ❌, ❌
v2.10, ✅, ✅, ✅, ✅, ❌, ❌
v2.9, ❌, ✅, ✅, ✅, ❌, ❌
v2.8, ❌, ❌, ✅, ✅, ✅, ❌
v2.7, ❌, ❌, ❌, ✅, ✅, ✅
Nevertheless, you can also use this library for all older Redmine versions.
In this case, however, be aware that some features might not be supported by your Redmine server.
If a new Redmine version enables new features that are not yet supported with this library,
you are welcome to create an issue.
Requirements
Redmine is missing some APIs for a full remote management of the data:
By using Composer you can simply run:
at the root of your projects. To utilize the library, include
Composer's
For example,
```php
A simple PHP Object Oriented wrapper for Redmine API.
Uses Redmine API.
Features
- Follows PSR-4 conventions and coding standard: autoload friendly
- Choose between using native
cURLfunction or any
like Guzzle for handling http connections
- mid-level API e.g.
$client->getApi('issue')->create(['project_id' => 1, 'subject' => 'issue title']);
$response = $client->getApi('issue')->getLastResponse();
- low-level API e.g.
$response = $client->request(
HttpFactory::makeJsonRequest(
'POST',
'/issues.json',
'{"issue":{"project_id":1,"subject":"issue title"}}',
),
);Supported Redmine versions
We support (and run tests against) the latest supported Redmine versions
that receive security updates.
php-redmine-api, 7.0, 6.1, 6.0, 5.1, 5.0, 4.2
v2.11, ✅, ✅, ✅, ✅, ❌, ❌
v2.10, ✅, ✅, ✅, ✅, ❌, ❌
v2.9, ❌, ✅, ✅, ✅, ❌, ❌
v2.8, ❌, ❌, ✅, ✅, ✅, ❌
v2.7, ❌, ❌, ❌, ✅, ✅, ✅
Nevertheless, you can also use this library for all older Redmine versions.
In this case, however, be aware that some features might not be supported by your Redmine server.
If a new Redmine version enables new features that are not yet supported with this library,
you are welcome to create an issue.
Requirements
- PHP ^8.2
- The PHP SimpleXML extension
- The PHP JSON extension
- Enabled REST web service on your Redmine server
- Go to Administration -> Settings -> Api (
/settings/edit?tab=api) and check the "Enable REST web service" box - Obtain your API access key in your profile page:
/my/account - (or use your username & password; not recommended)
- The PHP cURL extension if you want to use the native
cURLfunctions. - PHPUnit >= 11.5 (optional) to run the test suite
- Tracking of Redmine API feature support in #305
Redmine is missing some APIs for a full remote management of the data:
- List of activities & roles: https://www.redmine.org/issues/11464
- Open issues because of missing Redmine API
By using Composer you can simply run:
$ php composer.phar require kbsali/redmine-apiat the root of your projects. To utilize the library, include
Composer's
vendor/autoload.php in the scripts that will use theRedmine classes.For example,
```php