51 lines
1.1 KiB
Markdown
51 lines
1.1 KiB
Markdown
# Active Collab API
|
|
|
|
> Note: I have tested this API against the Cloud-Hosted version of [Active-Collab](https://activecollab.com/), not with the self-hosted installation!
|
|
|
|
## Useful links
|
|
|
|
* https://developers.activecollab.com/api-documentation/index.html
|
|
* https://github.com/activecollab/activecollab-feather-sdk
|
|
* https://stackoverflow.com/questions/tagged/activecollab
|
|
|
|
## Workflow
|
|
|
|
1. Login with username and password to Authentication Server and get back the `intent` for the user
|
|
2. Request a token for some Account (user could have multiple accounts) using the Account `url` and the users `intent`
|
|
3. Use the token to authenticate for every other API-Call
|
|
|
|
## CLI (Work in progress)
|
|
|
|
> activecollab [options] [object] [command] {arguments}
|
|
|
|
The output will be always serialized to JSON.
|
|
|
|
|
|
### Options
|
|
|
|
Mandatory options:
|
|
- config=<file> - read config from file (json)
|
|
|
|
### Object
|
|
|
|
- info - print version nummer from server
|
|
- account - all accounts you have access to with your login
|
|
- project - manage projects in Active Collab
|
|
|
|
Future:
|
|
- task
|
|
- subtask
|
|
- people
|
|
- invoice
|
|
|
|
### Command
|
|
|
|
- list - List all items
|
|
|
|
Future:
|
|
- get
|
|
- create
|
|
- update
|
|
- delete
|
|
|