Manage API credentials through Enterprise Hub

Prev Next

Overview

Use the API & Integrations module in Enterprise Hub to enable API credentials on your account and simplify Client ID & Secret key management.


Who uses this feature

  • Applies to all business types

Feature configuration

  • This feature requires an Enterprise Hub network. Contact your Customer Success Manager to request a network or contact technical support for details.

Things to know

  • To access API & Integrations, your users must have the appropriate permissions added to their roles. For more, see Manage user roles in Enterprise Hub.

  • Use the API & Integrations module only if you consider your organization to be the resource owner of the data under all the tenants.

  • Contact your customer success manager (CSM) and make sure all your Tenant IDs are added to the Enterprise Hub network.

  • A network is a set of all your tenant IDs in Enterprise Hub.

  • A group is a subset of your tenant IDs that you create to connect to an App.

  • Generate one pair of Client ID & Secret key for each group and App and use the same pair across all the tenant IDs when making the API call. 

Use cases

  • Customer: Good Plumbing with 50 tenants (IDs). Tenant 1, Tenant 2, Tenant 3 … Tenant 50

  • Network: Good Plumbing Network consists of all 50 tenants (IDs). Tenant 1, Tenant 2, and more.

  • Group: A group is a full set or a subset of the tenants that are a part of the network connecting to the same App.

    • For example, Group 1: Tenant 1, Tenant 2, Tenant 15, Tenant 50: Connecting to App 1. Group 2: Tenant 1, Tenant 2, Tenant 25, Tenant 40: Connecting to App 2.

  • Client ID & Secret key: A single pair of Client ID & Secret keys can be generated at the Group level and can be shared across all the tenants that are a part of the same group. That means you can pass the same Client ID & Secret key to all the tenants (IDs) that are a part of the group. 

    • Group 1: Tenant 1, Tenant 2, Tenant 15, Tenant 50: Connecting to App1: Will share the same Client ID (X1) and Secret key (Y1)

    • Group 2: Tenant 1, Tenant 2, Tenant 25, Tenant 40: Connecting to App 2: Will share the same Client ID (X2) and Secret key (Y2)

Generate the multi-tenant Client ID & Secret key pair through Enterprise Hub

Prerequisites

  1. Make sure a developer creates the App through the developer portal.

  2. Log in to My Apps.

  3. Contact your CSM to get your Enterprise Hub Network ID. When your network is created in the Enterprise hub, a network ID will be generated.
    Form for creating a new app with required fields and organization details.

Grant access to API and Integrations

To grant access to API and Integrations for a role:

  1. In Enterprise Hub, click User Management.
    Overview of User Management module for managing user permissions and access.

  2. Select Roles.
    User management interface displaying roles and their descriptions for permissions assignment.

  3. In the EnterpriseHub permissions tab, enable the View permission for API & Integrations.

  4. Either create a new user role or edit an existing user role.

  5. In the EnterpriseHub permissions tab, enable the View permission for API & Integrations.
    User selects the 'View' permission in the API & Integrations settings interface.

  6. Click Save Changes. Users assigned this role can now see the API & Integrations module in EnterpriseHub.

Step 1: Log in to your Enterprise Hub

  1. Log in to your Enterprise Hub using your credentials.

  2. Click the API & Integrations module.
    Overview of API and Integrations module for managing app credentials in Enterprise Hub.

Step 2: Create a New Group

  1. Click Create New Group.
    Interface for managing API Client IDs and creating new groups for integrations.

  2. Enter the name of your Group. 

  3. Click Create Group.
    User interface for creating a new group in API and integrations section.

  4. Select all the tenants you want them to be a part of this Group.
    Selection interface for tenants with options to save or cancel changes.

  5. When finished, click Save. Your group is created and appears on the page.
    List of API groups with their IDs and actions for managing integrations.

  6. Click More to perform the following operations:

    1. Edit: To add or remove tenants from the group

    2. Delete: You can delete the group

    3. Connect New App: You can subscribe to an App for the group and create a Client ID & Secret key at the group level.
      Menu options for managing groups including edit, delete, and connect new app features.

Step 3: Connect New App to the Group

On your newly created Group, click Moreand select Connect New App.

API integration interface showing options to create, edit, or connect new applications.

Step 4:  Select the App you want to connect

  1. Choose the specific App you want to connect to the group and click Connect New App.

  2. On the Terms and Conditions window that opens, read the terms and conditions and click Accept.

  3. Select the App you want to connect to and click Connect.
    List of available apps with highlighted selection for flalaxy Business Units.

  4. Click  Allow Access.
    flalaxy Business Units requests access to your ServiceTitan account for reading and writing.A message confirming that the App is connected appears.

  5. Click Generate.
    Application details showing successful connection and client information for flalaxy Business Units.

  6. On the window that opens, click Yes, Continue. The Client Secret opens.
    Client secret displayed with a note about its visibility and importance for security.

Step 5: Embed the generated Client ID & Secret key into your App

When you connect a new App to a Group, a new Client ID & Secret key is generated. Embed this newly generated Client ID & Secret key to your App.

Step 6: Use the same Client ID & Secret key for all tenants in the Group

Pass the same pair of Client ID & Secret keys each time you want to make an API call on behalf of any tenant that is part of the Group connecting to the App.

Want to learn more?