Bookio Rental Public API (1.0)

Download OpenAPI specification:Download

Introduction

This API is documented in OpenAPI format. It's still a work in progress so please let us know about any issues at dev@bookio.com.

Authentication

Token based authentication. Access to bookio API with specific channel assigned to the token.

Bearer

Provided secret API token must be sent in Authorization request header:

    Authorization: Bearer <token>
Security Scheme Type API Key
Header parameter name: Authorization

Error codes

ErrorCode Description
10 Generic validation error, errors field will give more information
11 Payment error, reservation cannot be marked as paid
20 Invalid token or missing access rights
30 Cars are occupied
40 Duplicate reservation
404 Not found
666 Unspecified internal error, this will be reported to us and we will look into it shortly

Facility

Get facility by GID

Returns facility by GID if you have enough access rights

Authorizations:
path Parameters
Gid
required
string
Example: abc123

Global ID of facility

Responses

200

Successful operation

400

Bad request

get/facilities/${Gid}

Staging server.

https://test.rental.bookio.com/public/api/v1/facilities/${Gid}

Production server.

https://rental.bookio.com/public/api/v1/facilities/${Gid}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "result":
    {
    }
}

List of facilities by access token

Returns facilities by access rights

Authorizations:
query Parameters
offset
integer >= 0
Default: 0
Example: offset=50

Determines the offset within pagination.

limit
integer [ 0 .. 100 ]
Default: 100
Example: limit=50

Limits the result set.

Responses

200

Successful operation

400

Bad request

get/facilities/by-token

Staging server.

https://test.rental.bookio.com/public/api/v1/facilities/by-token

Production server.

https://rental.bookio.com/public/api/v1/facilities/by-token

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "result":
    {
    }
}

List of facility networks

Returns facility networks

Authorizations:

Responses

200

Successful operation

400

Bad request

get/facilities/networks

Staging server.

https://test.rental.bookio.com/public/api/v1/facilities/networks

Production server.

https://rental.bookio.com/public/api/v1/facilities/networks

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "result":
    {
    }
}

Widget

Reservation widget page

Widget spec for implementing to external pages via iframe or as a direct link. Reservation source is automatically determined from the HTTP referrer.

path Parameters
channel
required
string

Unique string id of specified channel.

facilityGid
required
string
Example: abc123

Unique id of specified facility you want to make reservation in.

query Parameters
css
string
Example: css=https://mydomain.com/assets/mycustom.css

Possibility to add custom css and customize the design of our widget to one's needs. The CSS is changed by overriding our classes with one's own. Our classes are not documented, so there is a need to look at the source.

Responses

200

HTML content

404

Wrong GID, facility does not exist or is not active

get/{channel}/widget/{facilityGid}

Staging server.

https://test.rental.bookio.com/public/api/v1/{channel}/widget/{facilityGid}

Production server.

https://rental.bookio.com/public/api/v1/{channel}/widget/{facilityGid}