API - How to register the API key

How to Register the API Key in Sprinthub CRM

Sprinthub CRM allows you to integrate various platforms to automate processes and improve your team's performance. One of these integrations is done through the use of an API key, which is essential to establish secure communication between systems. Below, we will teach the step-by-step process of how to register the API key in Sprinthub CRM.

Step 1: Access the Settings Menu

1. Open the Sprinthub CRM and log in to your account.

2. In the top right corner of the screen, click the gear icon to access the settings menu.

Step 2: Navigate to the Integrations Section

1. In the side menu, locate and click the Documentation and API key option.

Step 3: Generate or Add an API Key

1. Click the Generate New Key if you do not have one yet.

   • A unique code will be generated that will serve as your access key.

2. If you already have an API key, click Add Key and enter the code provided by the platform you want to integrate.

When clicked, the option will appear to add a name, the user from which it will inherit permissions, and an enabled or disabled status.

Attention: Make sure to copy the key exactly as it is displayed, as any error will prevent the integration.

Step 4: Configure Permissions

1. After registering the key, you will be able to configure the permissions for the integration.

2. Choose the resources that the integrated platform can access, such as:

   • Contacts

   • Leads

   • Deals

Click Save to confirm the settings.

Step 5: Test the Integration

1. After configuring the API key, it is important to test the connection.

2. Check if data is being sent and received correctly between the platforms.

Done! Now your API key is registered and working in Sprinthub CRM. If you have questions or encounter problems during the process, contact Sprinthub technical support.