API keys allow you to securely connect your applications with our Business API services. This guide walks you through the simple process of generating an API key for your account.
Important: Your API key will only be shown once. Make sure to copy and store it in a secure location immediately after generation.
Step-by-Step Instructions
1. Navigate to Business API
From your main dashboard, locate and click on the "Business API" option in the left navigation menu.
2. Access API Keys Section
Once the Business API menu expands, select the "API Keys" option from the submenu.
3. Generate a New Key
Scroll to the bottom of the API Keys page and click the "Generate" button. You'll see a confirmation screen explaining that this will create a unique key to access API services.
4. Copy Your API Key
After generation, your new API key will be displayed on screen. Click the "Copy" button next to the key to copy it to your clipboard.
Security Notice: The key will disappear after you've copied it as a security measure. You will not be able to retrieve this key again, so ensure you store it safely.
5. Complete the Process
After copying your key, click the "Done" button to finalize the process. You should see a confirmation message that your API key has been copied to clipboard.
Next Steps
Store your API key in a secure password manager or secret management system
Never share your API key publicly or commit it to source code repositories
Consider setting up token expiry policies for enhanced security
Use your new API key to authenticate your API requests following our API Documentation
Use the generated access token in the
Authorizationheader as follows:Authorization: Bearer {your_access_access_token}
Important Note
Only businesses that have been approved to access the API will have the ability to generate an API Key. If you don't have access to the API, please send an email to [email protected] explaining your use case and what APIs you want access to.
Troubleshooting Common API Issues
Resolving “Invalid Credentials” Errors
An “Invalid Credentials” error usually occurs when your credentials or API base URL mismatch. Here’s how to resolve this issue:
Confirm that your API key corresponds to the environment you are working in (e.g., production or sandbox).
Ensure the email provided matches the business email associated with your API key.
Verify that the API endpoint URL matches the intended environment (test or production).
Generating an Access Token
To generate an access token, follow these steps:
Ensure you have an active API key. If not, generate a new one using the steps above.
Use the following details for your API call to the token endpoint:
Request Type: POST
Request Body (JSON):
{ "email": "your_registered_business_email", "apiKey": "your_new_api_key" }Replace
your_registered_business_emailwith the email associated with your Kuda Business account andyour_new_api_keywith the API key you created.
The API response will provide an access token. Include it in all API requests using the following header:
Authorization: Bearer {your_access_token}Additionally, for advanced integrations requiring credentials such as Client ID, Public Key, and Private Key, you will need to submit an application to the Kuda sales team. Upon approval, these credentials will be provided along with onboarding instructions.