dRofus REST API

This document provides reference materials for using the dRofus REST API for data from a given database. For the database management REST API, se this: Admin system REST API

This API is providing an Open API specification describing the API. We also have an interactive GUI that lets you explore this API and try it out in the browser. Since we expose and document how to get database/project specific properties we require you to login to see the documentation. See Authentication below.

Provide feedback

Do not hesitate to contact us and provide feedback on what use cases you would like to use the API for.

URLS

The API is currently deployed to the following locations. More will follow. The API documentation will expose project specific properties so you need to log in to see it. Please see dRofus REST API#Authentication section below for how to connect with your dRofus username and password.

Authentication

Currently we support bearer tokens and basic authentication (username and password). If you would like to use tokens - please reach out to support@drofus.com and we can provide needed information..

Providing database and projectId

All API endpoints should provide database and project id as part of the url. E.g. https://api-xyz.com/database/projectId/api/rooms

[Deprecated] Providing database and projectId in basic auth   

Currently it is still possible to add database and project id as part of username when using basic auth. This is deprecated and not recommended. But still needed if you want to see the project specific API documentation in swagger.

NameMeaning
db-nameThe database-name as you would enter in dRofus Client
project-idId of project. Usually '01'. This is optional only if database only contains one project
user-nameThe name you log on with in dRofus client
languageThe language you want to see data in. Optional, and default is the language configured for the database

Queries

We model our query-syntax on the OData standard, but currently only support a small subset of it. 

ArgumentDescriptionSample
$selectA comma-separated list of columns to return. 'id' will always be returned$select=name,architect_no
$orderbyA comma-separated list of columns to sort by. Sorting direction can be specified using asc or desc.  Default is asc. If no orderby is specified, the result is sorted by id$orderby=name,architect_no desc, 
$filter

Used to restrict which rows are returned.  A column can have a criteria to filter by. The value for filter can be quoted to handle embedded spaces and strings. Currently only 'and' can be used to combine multiple filters. 

Operators:
OperatorDescription
EqEquals
NeNot equal
LtLess than
GtGreater than
LeLess than or equal
GeGreater than or equal
InIs a member of
ContainsString contains a sub-string

$filter=created gt '2019-1-1'

$filter=name in ('kitchen', 'office')

$filter=id in (1001, 1003, 1005)

$filter=contains(name,'kitch')


$topMax number of rows to return. Default is 10000. If more data is available than is returned, the result will contain a RFC5988 header value$top=123
$skipHow many rows to skip on result-set. Default is 0. Can be combined with $top to implement paging$skip=100

Full API documentation

The Api is described in a standard format, called Open API (formerly known as Swagger)

The basic general documentation for our API will be found under 'swagger/default/swagger.json'. But since our database is highly confiburable, a version with all database-specific files in the schemas are available under 'swagger/v1/swagger.json', but requires logon. 

RFC5988

Rfc5988 is an internet standard for navigating between pages in result-sets. Essentially it looks like this, and contains the full link for additonal data in the response headers: 

<http://localhost/api/database/01/rooms?$skip=1&$top=1>; rel=\"next\">

Examples

Examples of how to use the API: