If you choose to install this application with Composer instead of pulling down the git repository you will need to add a composer.json file to the location you would like to pull the repository down to featuring:<\/p>\n\n
`json\n<\/code><\/pre>\n\n{\n \"require\": {\n \"activecollab\/activecollab-feather-sdk\": \"^3.0\"\n }\n}\n `<\/p>\n\n
Run a composer update<\/code> to install the package.<\/p>\n\nNote<\/em>: If you used an older version of Active Collab API wrapper and loaded it using dev-master<\/code>, lock it to version 2.0 by setting require statement to ^2.0<\/code> and calling composer update<\/code>.<\/p>\n\n\nConnecting to Active Collab Cloud Accounts<\/h3>\n\n`php\n<\/code><\/pre>\n\n<?php<\/p>\n\n
require_once '\/path\/to\/vendor\/autoload.php';<\/p>\n\n
\/\/ Provide name of your company, name of the app that you are developing, your email address and password.\n$authenticator = new \\ActiveCollab\\SDK\\Authenticator\\Cloud('ACME Inc', 'My Awesome Application', 'you@acmeinc.com', 'hard to guess, easy to remember');<\/p>\n\n
\/\/ Show all Active Collab 5 and up account that this user has access to.\nprint_r($authenticator->getAccounts());<\/p>\n\n
\/\/ Show user details (first name, last name and avatar URL).\nprint_r($authenticator->getUser());<\/p>\n\n
\/\/ Issue a token for account #123456789.\n$token = $authenticator->issueToken(123456789);<\/p>\n\n
\/\/ Did we get it?\nif ($token instanceof \\ActiveCollab\\SDK\\TokenInterface) {\n print $token->getUrl() . \"\\n\";\n print $token->getToken() . \"\\n\";\n} else {\n print \"Invalid response\\n\";\n die();\n}\n <h3>Connecting to Self-Hosted Active Collab Accounts<\/h3><\/code>php\nrequire_once '\/path\/to\/vendor\/autoload.php';<\/p>\n\n\/\/ Provide name of your company, name of the app that you are developing, your email address and password. Last parameter is URL where your Active Collab is installed.\n$authenticator = new \\ActiveCollab\\SDK\\Authenticator\\SelfHosted('ACME Inc', 'My Awesome Application', 'you@acmeinc.com', 'hard to guess, easy to remember', 'https:\/\/my.company.com\/projects');<\/p>\n\n
\/\/ Issue a token.\n$token = $authenticator->issueToken();<\/p>\n\n
\/\/ Did we get what we asked for?\nif ($token instanceof \\ActiveCollab\\SDK\\TokenInterface) {\n print $token->getUrl() . \"\\n\";\n print $token->getToken() . \"\\n\";\n} else {\n print \"Invalid response\\n\";\n die();\n}\n `<\/p>\n\n
SSL problems?<\/h3>\n\n
If curl complains that SSL peer verification has failed, you can turn it off like this:<\/p>\n\n
`php\n<\/code><\/pre>\n\n\/\/ Cloud\n$authenticator = new \\ActiveCollab\\SDK\\Authenticator\\Cloud('ACME Inc', 'My Awesome Application', 'you@acmeinc.com', 'hard to guess, easy to remember', false);\n$authenticator->setSslVerifyPeer(false);<\/p>\n\n
\/\/ Self-hosted\n$authenticator = new \\ActiveCollab\\SDK\\Authenticator\\SelfHosted('ACME Inc', 'My Awesome Application', 'you@acmeinc.com', 'hard to guess, easy to remember', 'https:\/\/my.company.com\/projects', false);\n$authenticator->setSslVerifyPeer(false);<\/p>\n\n
\/\/ Client\n$client = new \\ActiveCollab\\SDK\\Client($token);\n$client->setSslVerifyPeer(false);\n `<\/p>\n\n
Note:<\/strong> Option to turn off SSL peer verification has been added in Active Collab SDK 3.1.<\/p>\n\nConstructing a client instance<\/h3>\n\n
Once we have our token, we can construct a client and make API calls:<\/p>\n\n
`php\n<\/code><\/pre>\n\n$client = new \\ActiveCollab\\SDK\\Client($token);\n `<\/p>\n\n
Listing all tasks in project #65 is easy. Just call:<\/p>\n\n
`php\n<\/code><\/pre>\n\n$client->get('projects\/65\/tasks');\n `<\/p>\n\n
To create a task, simply send a POST request:<\/p>\n\n
`php\n<\/code><\/pre>\n\ntry {\n $client->post('projects\/65\/tasks', [\n 'name' => 'This is a task name',\n 'assignee_id' => 48\n ]);\n} catch(AppException $e) {\n print $e->getMessage() . '
';\n \/\/ var_dump($e->getServerResponse()); (need more info?)\n}\n `<\/p>\n\n
To update a task, PUT request will be needed:<\/p>\n\n
`php\n<\/code><\/pre>\n\ntry {\n $client->put('projects\/65\/tasks\/123', [\n 'name' => 'Updated named'\n ]);\n} catch(AppException $e) {\n print $e->getMessage() . '
';\n \/\/ var_dump($e->getServerResponse()); (need more info?)\n}\n `<\/p>\n\n
post()`` and ``put()`` methods can take two arguments:\n<\/code><\/pre>\n\n\ncommand<\/code> (required) - API command,<\/li>\nvariables<\/code> - array of request variables (payload)<\/li>\n<\/ol>\n\nTo remove a task, call:<\/p>\n\n
`php\n<\/code><\/pre>\n\ntry {\n $client->delete('projects\/65\/tasks\/123');\n} catch(AppException $e) {\n print $e->getMessage() . '
';\n \/\/ var_dump($e->getServerResponse()); (need more info?)\n}\n `<\/p>\n\n
delete()`` method only requires ``command`` argument to be provided.\n<\/code><\/pre>\n\n