yabab-dev / redmine-api

Use Redmine API with Javascript

Redmine API

Use Redmine API in browsers and NodeJS

Install

npm install @chymz/redmine-api

Quick Sample

import { RedmineAPI } from '@chymz/redmine-api';

const api = new RedmineAPI('https://domain.com', { login: 'user', password: 'pass' });
// or
const api = new RedmineAPI('https://domain.com', { key: 'your_api_key' });

// You can pass all ressources name
api.query('issues')
  .then(results =>  {
    // ...
  })
  .catch(err => {
    // ...
  });

Docs

See here for documentation

Implemented

• API Requester class (docs)
• Issues (docs)
• Projects (docs)
• Time entries (docs)
• Users
• Enumerations
• Custom fields
• Versions
• Issue Relations
• Issue Statuses
• Issue Categories
• Attachments
• Trackers
• Groups
• Roles
• News
• Wiki Pages
• Queries

NodeJS & old browsers

You will need fetch() function to do requests on Redmine API. You can get a polyfill :

• For NodeJS : https://www.npmjs.com/package/node-fetch
• For old browsers : https://www.npmjs.com/package/whatwg-fetch

License

See LICENSE file