What is RoundBee?
Roundbee is a time/task tracking JSON API. Website you are currently on is a demo-client of Roundbee JSON API.
What objects and functions are available?
Main three objects are Activity, Task and Project.
Activity is a main time tracking object. Activities may be linked to Tasks. Tasks can be grouped to Projects. All three objects can be listed, created, edited and deleted.
Activity can be started and stopped. API tracks summary time per Activity.
Should I be registered in order to use the API?
Yes, you should have User login and password in order to interact with API. Once logged in, User gets session key which is used with every request.
How can I register as User?
You can not. Only Subscribers can create Users using Subscriber's interface.
But how user can access API?
RoundBee time tracking API is still in Beta. If you want to join the project and get early access to API, please sign up on Roundbee Website, providing some information about yourself and how you wish to use the API. Unfortunately, we cannot approve all requests. If your request will be approved, you will receive User Account. Please specify if you require Subscriber's credentials and extended access to the API.
Who are Subscribers?
Subsciber is a company or an individual who has administrative access to API and pays for the service. Subscriber can create unlimited number of Users.
How service is paid?
Every User interaction with the API is called a 'pass'. Logging in, reading list of Tasks, starting or stopping Activity is a 'pass'. Subscribers buys 'passes' in packages, which are stored with Subscriber's account. Every pass made by User is deducted from Subscriber's account. Packages sold for example can have 10000 passes, which is approximately enough for month of usage for company of 5 people. When Subscriber account goes low on passes count, email notification will be sent, inviting to buy additional package. Once passes count is 0 or less (it's possible to work into some negative pass count), Subscriber and Users registered by Subscriber will not be allowed to do API requests.
What's a Pass ?
Pass is a payment unit.
- Each interaction with API costs User 1 Pass
- Subscriber's account is debited for all User's interactions with the API
Who's User ?
End-User of RoundBee API
- Actually uses API
- Has Activities, Tasks, Projects
- Created and granted access to API by Subscriber
How can I become a Subscriber?
Please register on Roundbee Website. FOR BETA PERIOD ONLY: while in BETA, the API is operating on donations. Donations will be spent on server equiplent. Not all applied will get Subscriber account. Early Subscribers will get discounts and benefits after API goes live.
What can I do when I get Subscriber access?
You can create unlimited number of Users. Then you can use API for time/task tracking. For example you can build your own mobile application or integrate RoundBee API with corporate systems in order to add time/task tracking capabilities to existing application.
Is there existing tool or app that is using RoundBee API?
There's application demo.roundbee.com that showcase features implemented in the API. This Demo application can be used for actual time/task tracking, but it has only basic features. Main idea is that YOU decide what to do with RoundBee API, and what application to build around it.
What are building blocks of API ?
- Tidbit: Ti(me) Bit, smallest time interval, user starts and stops tidbits
- Activity: the work you do, can have many Tidbits, as Activity can be started and stopped
- Task: bunch of Activities
- Project: bunch of Tasks or Activities