Creating an API Token for Integrations

Creating an API Token for Integrations

Objective

This article outlines the steps to create an API token for integrations, ensuring proper permissions are set for specific use cases. See video walkthrough here, and below is a step by step version. 


Key Steps

 

Step 1: Access the API Token Creation Section 0:02

  • Navigate to the API token creation section in your application.

  • Select 'Create Token' and give it a name (good practise to name it relevant to where it will be used, i.e. zapier)

 

Step 2: Choose Expiry date (Optional) 0:11

  • Decide whether to add an expiry date or not. If you add one, the API key will no longer work after this date and you will need to create a new one. 

 

Step 3: Set Permissions for the API Token 0:43

  • Review the permissions section where you can define what the API token can access.

  • You have two options:

    • Select All: Grants access to all items in your account.

    • Granular Permissions: Choose specific items (e.g., only documents) by unticking the other options.

 

Step 4: Save the API Token 1:06

  • After setting the desired permissions, click 'Save'.

 

Step 5: Copy the API Key 1:20

  • Locate the API key in the green header, displayed after saving.

  • Copy the API key and save it in a secure notebook or document.

 

Step 6: Use the API Key in Integrations 1:32

  • Import the copied API key into your integration tool (e.g., Zapier) as needed.

Cautionary Notes

  • Ensure that you only grant permissions that are necessary for the integration to minimise security risks.

  • Keep the API key secure and do not share it publicly.

Tips for Efficiency

  • If unsure about permissions, start with 'Select All' and refine later based on specific needs.

  • Maintain a secure document for all API keys to streamline future integrations.


    • Related Articles

    • Worx Safety API Documentation

      Overview The Worx Safety API allows you to programmatically access and manage your safety management data. Use the API to integrate Worx Safety with your existing business systems, build custom reporting dashboards, automate data synchronisation, or ...

    • Using the Worx Safety - Zapier Integration

      Overview Worx Safety integrates with Zapier, giving you seamless connectivity to over 6,000 apps and systems without writing any code. This integration allows you to automate workflows between Worx Safety and popular business tools including ...

    • Adding a Simpro Integration to your Worx Safety Account

      This article walks through how to set up the Simpro integration in your Worx Safety account. Using this integration should save a lot of doubling up on data entry, and also ensure the same data is present in both accounts, removing the risk of ...

    • Creating your new Worker Account

      In this video, I guide you through the process of creating your worker profile after receiving an email to set up your account. You'll need to follow the onboarding journey, input your details, and upload a profile photo, along with any mandatory ...

    • Visual walk through of Simpro Integration

      This video demonstrates how the Work Safety and Simpro integration streamlines your workflow by connecting safety management with job scheduling and project management. You'll see how sites, Digitial SWMS and form submissions automatically sync ...