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 a API key, which is essential for establishing secure communication between systems. Below, we will teach you step by step how to register the API key in Sprinthub CRM.

Step 1: Access the Settings Menu

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

2. In the upper-right corner of the screen, click the gear to access the settings menu.

Step 2: Navigate to the Integrations Section

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

Step 3: Generate or Add an API Key

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

   • A unique code will be generated that will work 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 you click it, the option to add a name, the user whose permissions will be used, and the enabled or disabled status will appear.

Attention: Make sure to copy the key exactly as it is displayed, because 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 on Save to confirm the settings.

Step 5: Test the Integration

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

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

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