Introduction

An API, short for Application Programming Interface, is used to exchange data between software programmes and apps in a formalised way. Using an API token, you therefore have the ability to establish an API integration with a third party, if it does not already have an integration with CrewPlanner.

Suppose that you, as a CrewPlanner client, have a supplier without an existing integration to CrewPlanner, then we offer the possibility to still retrieve certain information from CrewPlanner and process it at will using a Client or Agency API token.

You can create and manage these API tokens yourself via the API TOKENS page, which can be found in the SETTINGS menu on the right. This page also provides you with documentation that allows the third party to build a Client API.

Prepare for an API integration

At the top of the API token page you have the following options, CREATE AN API TOKEN and TO DOCUMENTATION.

Before you create an API token, you should first provide the necessary information to your third party so that they can prepare to integrate with this API token. Therefore, first select TO DOCUMENTATION, where you can find the necessary information.

You are then given three options that lead to the relevant information for the type of link you wish to create:

Client API: this integration allows performance data to be forwarded to third parties
Payroll API: this integration connects Payroll companies with their clients in CrewPlanner
Agency API: this integration connects employment agencies or project agencies with their clients in CrewPlanner

It is therefore important that you share the correct documentation with your supplier or third party.

Create an API token

To create an API token in CrewPlanner, you proceed in the same way for the three different types. However, if you wish to link to a payroll, employment or project agency that is not yet integrated with CrewPlanner, you should first contact us at [email protected]!

We will therefore only discuss further how to create a Client API:

To retrieve performance data from CrewPlanner, you need a Client API. Based on the relevant documentation, your supplier on their side can make the necessary preparations to create this API token.

Once this is in place, simply create an API token for this supplier, by selecting CREATE AN API TOKEN. You will then be directed to the next page:

You then take the following steps:

Give the token a name recognisable to you, for example that of the third party for which you are creating the API token.
Select the access you wish to grant by ticking the relevant; currently we support a link for reporting your worked hours and employee data.
Create the token by selecting SAVE.

The API token overview

Once you have created the token, it will appear in the token overview on the API token page. What information can be found here:

Name: the name you noted when creating this token.
Access: this shows which information you grant access to.
Last used on: here you can consult when this token was last used by the third party.
Pencil icon: select this to edit or consult the token. We will discuss this in more detail in a moment.
Bin icon: use this to delete the token.

Consult and copy an API token

As mentioned earlier, you consult an API token by selecting the pencil icon next to the token in question in the overview.

This will take you to the page below, where you will find the secret token on the right-hand side.

Once you select the clipboard icon, this token becomes fully visible and copied for you.

This way, you can share the token with your third party.

CrewTip: We recommend that you handle this token with great caution as it allows you to share your sensitive and employee data.

Using this secret key, your partner can extract all reporting data from your environment at will at any time. However, it may opt to retrieve this data only on a weekly or monthly basis, for example.

In conclusion, based on the API documentation and the secret key you create for them, it is up to the third party to build their own integration that can connect with the CrewPlanner logic.

Delete an API token

As also mentioned earlier, you delete an API token by selecting the bin icon in the overview.

Once you select this icon, the following pop-up opens:

If you then press Confirm, this API token will be deleted and the third party will no longer have access to your data.

We hope this article has helped you!

If you still have questions, take a look at our Crew Academyfirst. You might find the answer in one of our articles.