Skip to main content
Securely authenticating your requests is the first step to interacting with the Kimp360 API. This guide provides detailed information on how to authenticate using API keys, best practices for key management, and how to troubleshoot common authentication issues.

​
Authentication Overview

The Kimp360 API uses API Keys to authenticate requests. All API requests must include a valid API key. Requests made without a valid key, or with an improperly formatted key, will result in an authentication error.
What is an API Key?
An API key is a unique string that the API uses to identify and authorize you (or your application). It’s like a password for your API access, so it’s crucial to keep it secure.

​
Obtaining Your API Key

To start making API calls, you first need to obtain an API key:
1

Access Your Kimp360 Dashboard

Sign in to your Kimp360 account and from sidebar click on My Account > Settings and then click on Zapier Integration tab. Kimp360 API key page
2

Generate or Find Your API Key

In the Zapier Integration tab, you can generate a new API key or view your existing key. If generating a new key, you may be asked to name it for easy identification (e.g., “Kimp API Key”).
3

Copy and Store Your Key Securely

Once your API key is shown, copy & store it in a secure location, such as a password manager or a secure environment variable for your application.
Important: Secure Your Key!
Your API key grants access to your Kimp360 data and resources. Never share it publicly, embed it directly in client-side code (like JavaScript in a browser), or commit it to version control (e.g., Git).

​
Making Authenticated Requests

To authenticate an API request, you must include your API key in the x-api-key HTTP header. Example Request Header: 
x-api-key: YOUR_API_KEY
Replace YOUR_API_KEY with the actual API key you obtained. Full Example using cURL: 
curl -X GET "https://api.kimp360.com/some-resource" \
     -H "x-api-key: YOUR_API_KEY" \
     -H "Accept: application/json"
Header Name Case-Sensitivity
While HTTP header names are generally case-insensitive according to RFC 2616, it’s best practice to use the exact casing x-api-key as specified in the documentation to avoid potential issues with intermediaries or server configurations.

​
🛡️ Security Best Practices for API Keys

Proper management of your API keys is critical for the security of your integration and data.

Keep Keys Confidential

Treat your API keys like passwords. Do not embed them in publicly accessible code, such as client-side JavaScript or mobile apps that can be decompiled.

Use Environment Variables

Store API keys in environment variables on your server. This prevents them from being hardcoded into your application source code.

Rotate Keys Regularly

Periodically regenerate your API keys, especially if you suspect a key might have been compromised or if an employee with access leaves your organization.

Secure Your Backend

If your application involves a backend server making API calls on behalf of users, ensure that server is well-secured to protect the API keys stored there.

​
Troubleshooting Authentication Errors

If you encounter authentication problems, you’ll typically receive a 401 Unauthorized or 403 Forbidden HTTP status code.
Meaning: The request lacks valid authentication credentials. Possible Causes: * API key is missing from the x-api-key header. * API key is incorrect or has a typo. * API key has been revoked or has expired. * The x-api-key header is misspelled or has incorrect casing (though less common). Troubleshooting Steps: 1. Verify the x-api-key header is present in your request. 2. Double-check that the API key value is copied correctly, without extra spaces or characters. 3. Ensure the API key is active and has not been disabled in your Kimp360 dashboard. 4. If you recently regenerated the key, ensure you are using the new one.
Meaning: You are authenticated, but you do not have permission to access the requested resource or perform the requested action. Possible Causes: * The API key used has insufficient permissions for the target resource or action (if granular permissions are supported). * You are trying to access a resource that does not belong to your account or project. Troubleshooting Steps: 1. Check the permissions associated with the API key in your Kimp360 dashboard (if applicable). 2. Ensure you are targeting the correct resource ID and that it belongs to the account associated with your API key.
If you continue to experience issues, please refer to our general API Error Handling guide or contact [email protected] with details of your request and the error received.