This page will help you get started with your new API.
Introduction
Welcome to the Rollee API here you will find information on the process as well as all the calls that you can make and need to be made in order to retrieve data from your users.
Getting Started
Rollee provides you with two environments to test and go live with the solution. The first test can be done on the sandbox with fake credentials returning anonymized data to allow you to see more details on what data points are available per data source. Production can then be used first to trial with specific users and then to go live with all users. This environment requires real credentials and returns real data.
Environments
We provide you with two different environments. The first is Sandbox in order to allow you to test our API without needing real credentials. The second is the Production environment where you will need real credentials in order to request data.
1. Sandbox
The first environment we provide is based entirely on fake credentials and data. This is to get a feel for how the system works and the data you get back.
In Sandbox mode, you can build and test your integration. You must use test credentials to authenticate with payroll and gig platforms
All API endpoints return mock data which is static and updated periodically; Meaning a deeper understanding of the up-to-date data should be done on a test environment with real credentials and real data. Name and Logo show on Connect.
On Sandbox:
- Fake credentials only
- No error testing
- Static data returned
2. Production
This environment is live with your users. Analytics will be running and available in this environment.
API endpoints return real data and platforms are kept up to date.
On Production:
- Real credentials only
- Real data returned
- Logo and customizations (required)
- Custom list of data sources in search (optional)
Anthentication
The rollee's API is protected with JWT authentification. The initial token is provided by rollee with a certain validity time period.
You can create a new valid token, when the previous one is closed to expire, using the API.
Examples using curl:
- Get list of users
curl -X GET -H "Authorization: Bearer <YOUR_TOKEN>" https://api.getrollee.com/api/v0.4/users
- Refresh token
curl -X GET -H "Authorization: Bearer <YOUR_TOKEN>" https://api.getrollee.com/api/v0.4/token/refresh
json response:
{
"token": "YOUR_NEW_TOKEN"
}
In case of wrong usage of the token, API's call will return a 401 Unauthorized response.
Conventions
Here is a list of conventions about some terminology used by Rollee products regarding the usage of the API.
Users
Users are our customers' users (eg. drivers). Each user registered through the Rollee's connect product are assigned a unique UUID which will be used in the API's calls or responses.
Datasources or Platforms
Datasources are what we call the various sources of incomes users may have. This may be payroll platforms, driving and delivery platforms as well as freelance platforms. Rollee will collect and process data and service this data to our customers. (contact rollee support to have the list of supported datasources).
Accounts
Accounts represent the links between a user and a datasource. Users can have multiple accounts if they connect to numerous datasources through Connect. Each account is also identified with a unique UUID.
Endpoints
Endpoints are business entities under which sets of data are organized and served by the API.
For example, the profile endpoint serves data about the identity of users.
Webhooks
Webhooks are HTTP calls defined by our customers to deliver responses from the API calls in an asynchronous way. See documentation dedicated to webhooks for more information.
Dates and IDs
Some conventions used throughout our API and documentation are:
- All date-times are returned as strings in RFC 3339 order in UTC Timezone, like:
2021-06-30 14:30:00 UTC - All IDs are represented as UUIDs, e.g.,
01234567-89ab-cdef-0123-456789abcdef