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 of Platforms

Datasources are what we call the various sources of incomes users may have. These 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's 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.

The list of endpoints are:

  • activity
  • documents
  • income
  • trips
  • profile
  • vehicle

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

Did this page help you?