Skip to main content
Carbuddii has a new owner! Click here to know more

Search

Welcome to our Knowledge Base

How to create an API key

Juan Laiglesia
  • Updated

 

Managing API Keys in CarBuddii

API keys allow external systems, websites, and third-party applications to communicate securely with your CarBuddii dashboard. Depending on your needs, you can set up integrations to automatically push new leads into your pipeline or allow external software to read and sync data directly from your account.
 

Where to Find API Keys

To manage or view your existing API integrations, you must have an Admin user role.

  1. Log in to the CarBuddii dealer dashboard at app.carbuddii.com.

  2. Navigate to the Settings page via the main menu.

  3. Locate and select the Integrations section.

  4. Here, you will see your API keys divided into two distinct categories: API keys for digital requests and API keys for extensive integrations.


 

Understanding the Differences

It is crucial to generate the correct type of API key based on what you want the external system to do:

API Key Type What it does
API keys for digital requests Write-only: Allows external sources (like a website contact form) to push new leads into CarBuddii. It cannot read or see your existing data.
API keys for extensive integrations Read & Write: Allows external software (like a DMS or CRM) to insert data and pull sensitive customer information out of CarBuddii. Use with  caution.

 

 

How to Create a New API Key

  1. Go to Settings > Integrations on your dashboard.

  2. Decide which level of access your partner or software requires based on the table above.

  3. Under the appropriate section (Digital requests or Extensive integrations), click the button to create a new API key.

  4. Give the key a clear, identifiable name (e.g., "Main Website Lead Form" or "DMS Sync"). This makes it easy to remember what the key is used for if you ever need to delete or replace it later.

  5. Copy the generated key. Note: Treat API keys like passwords. Store them securely and only provide them to trusted developers or partners.

 

 

Technical Note for Developers: CarBuddii utilizes two kinds of authentication: an API key and a Bearer token. The API keys generated in this section are used to authenticate with our endpoints to gain an access token (which cycles every 1800 seconds). This temporary access token is then used as a Bearer token for all other authorized API requests.

 

You can read more on Authentication in our Developer Documentation. 

Comments

0 comments

Please sign in to leave a comment.