Introduction

Required Access

Before starting, make sure you have:

• Access to the TIMIFY Developer Platform.
  You need to request this from your Account Manager, who will arrange for a developer account to be created for you. Once the account is created, you will receive an invitation for the Developer Platform via e-mail, which you need to accept within 7 days.

• Access to a Company or Enterprise account where the app can be installed.

• A general idea of what your integration should do so you can pick the right scopes.

  If you have any questions about your accounts or issues with your access, please reach out to your Account Manager.

Creating an Application

1. Log into the Developer Platform.

2. Go to Apps in the top right to see the App Dashboard.

   

3. Click + NEW APP (top right) to start.

4. Select the app type:

   • TIMIFY Backend App for backend data sync only
   • TIMIFY UI App for an app with a user interface and frontend functionality. (DEPRECATED)
   

5. Select the app Visibility.
   Assuming this is a business-exclusive app for your specific needs, you would most probably go with Private.

   

6. Select the Country Visibility, depending on which population your app is intended for - this is useful if your business operates across many locations, and you wish to have an exclusive setup for each one.

   

7. Define the App Scope(s), depending on what the integration needs to do:

   

   You can update permission scopes at any time while the application is in Draft status.

8. Authorise your app using the Private Access Key, which can be found in your TIMIFY Company or Enterprise account.

   

9. Lastly, add your App Name and Category → click Create App.

   

10. Go back to your Company or Enterprise Account → Apps → Private Apps, where you will find your new app. Click Install.

    Please note that you can install each app on only one account (company or enterprise). This means that if you wish to use an app across multiple companies (branches), we recommend installing it on your Enterprise account, which will make it visible across all companies/branches. If needed, you can manage the country visibility as shown earlier in Step 6.