API Add-on

Get your tools to talk to Orangescrum

Efficient | Easy | Communicate | Integrate

  • API Key
  • API

Description

Orangescrum's API Add-on lets you manage how different components should interact with each other majorly with the GUI components. API add-on would help different components from disparate tools to connect with each other.

Creating a new task IN Orangescrum based on input from one of your other tools is as easy as posting to the create_task endpoint with a data block containing the fields you'd like to set on the task. Any unspecified fields will take on the Orangescrum default values.

Every task is required to be created under a specific project, and this project cannot be changed once set. The project need be set explicitly with user to which task will be assigned.

Features / Benefits

  • Efficiently share data and processes between your apps
  • Automate repetitive manual tasks
  • Connect your CRM, Team Foundation Server (TFS) etc. with Orangescrum
  • Less opportunity for manual error
  • Cost savings by eliminating manual data processing between internal systems
  • Secure data exchange between your systems

What do I Need?

Improve collaboration with easy integration among your internal apps

Send documents to orangescrum

Time entry, time log list view from your own time tracking app

Create, edit, manage,complete projects

Bring you action from others apps to Orangescrum

Add, invite, remove, users from your CRM other apps

Create, edit, reply, delete, archive tasks

My Problems

I have to manage multiple applications

My apps don't talk to each other

Too many data inconsistencies

Teams only work on their chosen application

Dependency on multiple software vendors

What You Need
  1. Apache with 'mod_rewrite'
  2. Enable curl in php.ini
  3. Change the 'post_max_size' and 'upload_max_filesize' to 200Mb in php.ini
    • PHP 5.4 or higher and less than PHP 7
    • MySQL 4.1 or higher
    • If STRICT mode is On, turn it Off.
Installation Steps

Add-on Installer Installation:-

  1. Make sure to keep a backup of your existing "app" folder of your current working directory.
  2. Extract the zip file(AddonInstaller-V1.6.zip) to your desktop.
  3. Remove the existing "app" folder from your working directory then copy and paste the extracted "app" folder inside "AddonInstaller-V1.0" to your working directory.
  4. If you are using local machine as storage (excluding Amazon S3), please replace the folder, named "files" inside the "app/webroot" folder from the back up to the current "app/webroot" folder.
  5. Give write permission to "app/Config", "app/tmp", "app/Plugin" and "app/webroot" folders.
  6. Import the "installer.sql" files from the extracted files to your current database. If you have already imported installer.sql before then no need to import it again. Only exception is if you are finding any new version of installer.sql then import to your current database.
  7. Do necessary changes to "constants.php" and "database.php" inside "app/Config" folder again as you have done earlier. For Example SMTP email credentials in constants.php and database credentials in database.php.
  8. Run your website once. Ex.
    http://localhost/orangescrum (if you are using localhost)
    http://127.0.0.1/orangescrum (if you are using IP)
    http://myprojects.orangescrum.com (if you are using any valid domain)
    Note: if you are facing any issue or seeing any blank page after doing all the above steps, then just do the following once.
  9. Replace "Configure::write('debug',0);" with "Configure::write('debug',2);" in the app/Config/core.php. Run the web url once and restore the debug value to 0 again. i.e Configure::write('debug',0);
    Congratulations!!

Add-on Installation:-

  1. Download the Add-on zip file.
  2. Place the downloaded zip file(Ex. API-V1.0.zip) in the "app/webroot" folder.
  3. Log in to the application.
  4. To install the add-on (Ex. API add-on) run below link once and follow the instructions.Ex. http://..../install/api (for API add-on)

  • Maintaining a logical understanding of the project before the Orangescrum was a
    task that was time consuming. With Orangescrum this is not a concern.

    Pedro Artur Oliveira Gestor de clientes (Manager) | CAIXA, Lda.
  • We used MS Excel for managing time log, now, we don't! We use Orangescrum's timelog feature to manage time. Further, we no more use MS word to export our invoices. We do it in a click :)

    Bala Consultant | IPneeti
  • OrangeScrum made our project management tasks and timesheets so much easier
    and support provided by team is awesome.

    Anil Kumar CEO, Saral Technologies
  • Orangescrum simplifies the process of project management for our organization with its power collaboration tools. We couldn't be happier with Orangescrum!

    Jamie Smith Director of Marketing Automation, SFCG, Texas, USA
  • By having a central tool for managing both my clients and project and also the ability to streamline business processes to match the goals of the company and deliver within budget and timelines, is the best thing a company can do.

    Khululekani Director | Thebe Media Solutions | South Africa
  • OrangeScrum helped us to be highly effective with - People & tasks planning, Tracking and Communication and updates with the complete team, Tracking of all projects,Resource utilization & Documentation management

    Sadanand Suresh Walte Delivery Head, Technex Technologies Pvt Ltd, Pune, India.
  • I work with Freelancers to get the CAD jobs done. Orangescrum provided me with a way for them to track and bill their time directly using in the project they are working on. This saves me a lot of administrational work. At the end of the month I just need to create the invoice for my customer

    Brent Kerr CEO, Kewico GmbH
  • The most beautiful thing about Orangescrum is easy in its approach which makes it a lot simpler to use. Orangescrum makes a complicated project way easier to run within my team.

    Kuda Msipa CEO Cutmec Group, Bristol, United Kingdom