Integration Setup Guide

This guide covers the steps required to begin integrating with Mobiledock via API.

Before Starting

Before commencing integration, please take the time to read through our Fair Use and Rate Limiting Policy.

Selecting an environment

Mobiledock has two separate environments, both of which can be integrated with. Each of these environments has its own dataset -- no data is synced between them.

The staging environment is typically used as a sandbox to test various configurations and processes, whilst production is used for live organisations and data.

The base URL for each environment is described below:

Environment	URL
Production	my.mobiledock.com
Staging	staging.mobiledock.com

For more information on environments, visit the Environments overview.

Selecting an organisation

The organisation is a core concept in Mobiledock. An organisation represents real world equivalent such as a location, carrier, supplier or tenant. Most Mobiledock API operations are in context of a particular organisation.

You will need an organisation ID to integrate with Mobiledock. This can be obtained by visiting the relevant Mobiledock environment, signing in and navigating to the Organisations page. From the organisations listed, click on the one that you'd like to interface with.

The organisation ID can then be obtained from the URL of the page. For example, take the following URL:

https://my.mobiledock.com/organisations/990090c9-7506-487b-9872-c4e65557ae75

The organisation ID is 990090c9-7506-487b-9872-c4e65557ae75.

Authenticating with Mobiledock APIs

In order to interface with Mobiledock, each request must be authenticated. In Mobiledock, this is done with a bearer token.

Creating a token

Bearer tokens can be created through the Mobiledock Integrations Hub. You will need to sign in with your Mobiledock account to access this hub.

Visit the hub that corresponds to the Mobiledock environment below:

Environment	URL
Production	integrations.mobiledock.com
Staging	integrations.staging.mobiledock.com

Once you are signed in, navigate to the Tokens page. If you have not already selected an organisation, you will be prompted to do so. You will have the option to Create New Token.

Permissions

In order for your Organisation Token to be able to perform Mobiledock API requests, it will need to be assigned the correct permissions. For security reasons, it is recommended to select the minimum number of permissions required to service the integration.

To view a list of all possible permissions, visit the Permissions section of the API.

Once created, the token will be visible on screen. Make sure to keep this token somewhere safe; after closing this confirmation window, it can no longer be displayed.

Accessing the API

With a bearer token created, you're now ready to access the API!

Every request to the Mobiledock APIs must be authenticated using the Authorization header.

Header	Value
Authorization	Bearer {{insert your token here}}

For example; if the token was xHHhL0u5zSehMQDuJYeKZO:

Header	Value
Authorization	Bearer xHHhL0u5zSehMQDuJYeKZO

Next Steps

For more information on the types of requests that can be made visit our GraphQL Queries or Mutations sections, or have a look at our Reporting Bookings Guide.

If, after reading this guide you have further questions, please contact us at assistance@mobiledock.com.