How to install API
Add-on On Orangescrum

Creating a new task is as easy as posting to the create_task endpoint with a data block containing the fields you'ld like to set on the task.

Steps below will guide you to install and integrate API Add-on to your Orangescrum.

Last Updated: 25th May, 2016
Print Print this page

  1. Step 1

    Extract the "api-v1.0" file (Buy API Add-on) to your working directory app/webroot folder.
  2. Step 2

    Now run the install.php file inside the "app/webroot/api-v1.0" folder in the browser as shown below. localhost/orangescrum/app/webroot/api-v1.0 /install.php
  3. Step 3

    Then a window appears with the list of files to change. Similar as shown below:
  4. Step 4

    Then click on "Click here to proceed" button to start installation process.
  5. Step 5

    After the installation process completed , go the bootstrap.php file in "app/Config/" folder and update the API_BASE_URL value as in the code below Configure::write('API_BASE_URL' , ' ');
    Ex. Configure::write('API_BASE_URL' , 'http://localhost/orangescrum/api/v1.0/');
  6. Step 6

    Now update the debug value to 2 from 0. Configure::write('debug',2);
    Run your site once and again reverse update the debug value.
    i.e. From 2 to 0
  7. Step 7

    Once you have completed all the process, you will be able to see the new API feature  in the task pane.
  8. If there is any issue in installing the api v1.0 add-on, please contact the orangescrum support team at We would be happy to help.

Last Updated: 25th May, 2016