README.md

Redmine API documentation

Initialize

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' });

Shortcuts

You can access to resources shortcuts via its name :

api.issues.get(13) // fetch issues
  .then(data => {
    // ...
  })
  .catch(error => {
    // ...
  });

api.projects // for projects
api.time_entries // for time entries

API Docs

• RedmineAPI
• Issues
• Projects
• Time entries