Some S4 Solutions modules (such as Kanban for Manufacturing, Bill.com, and Digikey integrations) require API credentials to connect with external services. When you purchase a module, S4 Solutions provides the API key in a text file attached to your invoice email. This guide shows you how to add and validate these API keys using Odoo's built-in Manage API Key interface.
Before you Begin
- You have purchased an S4 Solutions module from S4 Solutions
- You have received the invoice email from S4 Solutions with the API key text file attachment
- You have installed and activated the S4 Solutions module in your Odoo environment
- You have access to Odoo's Settings menu with Technical access rights
📖 What's in this guide:
Section 1: Locate Your API Key
- Step 1: Find your invoice email
- Step 2: Download the text file
- Step 3: Copy the API key
Section 2: Add the API Key in Odoo
- Step 4: Access Manage API Key
- Step 5: Locate your module
- Step 6: Enter the API key
- Step 7: Validate the key
Section 3: Verify the Integration
- Step 8: Check the status
- Step 9: Test the integration
Locate Your API Key
Find the API key that S4 Solutions sent you with your module purchase.
1 - Find your module invoice email from S4 Solutions
Search your email inbox for the invoice email from S4 Solutions for your module purchase. The subject line will typically include "S4 Solutions, LLC Invoice.".
Check your spam or junk folder if you don't see the email in your inbox. The email is sent automatically when your module purchase is processed.
2 - Download the text file attached to the email
The invoice email includes a text file (.txt) attachment containing your API key. Click on the attachment to download it to your computer.
3 - Review module information and copy the API key
Open the downloaded text file using any text editor (Notepad on Windows, TextEdit on Mac, or any code editor). The file contains:
- Your API key
- Getting started
- Support & Contact Information
Locate the API key in the file and select it. Copy the entire API key to your clipboard.
Make sure you copy the entire key without any extra spaces at the beginning or end. The API key is usually a long string of letters and numbers. Read through the other information in the file — it may contain helpful setup details.
Important: Keep this API key secure and don't share it publicly. It's unique to your module license.
3 - Open the text file and copy the API key
Open the downloaded text file using any text editor (Notepad on Windows, TextEdit on Mac, or any code editor). The file contains your API key. Select the entire API key and copy it to your clipboard.
Make sure you copy the entire key without any extra spaces at the beginning or end. The API key is usually a long string of letters and numbers.
Make sure you copy the entire key without any extra spaces at the beginning or end. The API key is usually a long string of letters and numbers.
Add the API Key in Odoo
Now you'll configure the API credentials in your Odoo environment.
4 - Enable developer mode and access the Manage API Key interface
First, enable developer mode:
- In Odoo, go to Settings (gear icon in the top menu)
- Scroll to the bottom and click Activate the developer mode
- The page will reload
Now access Manage API Key:
- Go back to Settings
- Click on the Technical tab
- Select Manage API Key
Developer mode must be enabled to see the Technical menu. You also need Technical access rights. If you don't see these options, contact your system administrator.
5 - Locate your installed module in the list
You'll see a list view showing all S4 Solutions modules that are installed and require API keys. Find the row for the module you just purchased and installed (e.g., kanban_for_manufacturing, fedex_integration, etc.).
If your module doesn't appear in the list, make sure it's properly installed and activated. You may need to complete the module installation process first.
Manage API Key — list of installed modules requiring API keys
6 - Enter the API key
Click on the API Key field for your module. Paste the API key you copied from the text file. Make sure there are no extra spaces before or after the key.
7 - Click "Validate API Key"
After entering your API key, click the Validate API Key button for that module. Odoo will verify the key is correct and active.
If validation succeeds, the Status column will change to "Valid" and show green. You're all set!
Verify the Integration
Confirm everything is working correctly
8 - Check the validation status
In the Manage API Key list view, verify that:
- The Status column shows "Valid" in green
- The Remaining Days shows the license expiration (if applicable)
- No error messages are displayed
9 - Test the module functionality
Navigate to the module's main feature area and test basic operations to ensure the module is working correctly. Try creating test records, running key functions, and verifying the module behaves as expected.
Congratulations! Your module is now active and ready to use.
9 - Test the module functionality
Navigate to the module's main feature area and test basic operations to ensure the module is working correctly. Try creating test records, running key functions, and verifying the module behaves as expected.
If you're testing in staging: Once testing is complete and you're ready to deploy to production, you'll need to remove the API key from staging and add it to your production environment. Remember, the API key can only be active in one environment at a time.
Congratulations! Your module is now active and ready to use.
🔧Troubleshooting
Common issues and how to resolve them.
❌ API key validation fails
If clicking "Validate API Key" results in an error:
- Double-check that you copied the API key correctly from the text file (no extra spaces)
- Verify you're using the API key for the correct module
- Make sure the module is fully installed and activated before adding the key
- Check if the API key is already in use in another environment (development/staging/production) — it can only be active in one place at a time
- Check that your API key hasn't expired (check the Remaining Days column)
- Contact S4 Solutions support if the key is correct but still won't validate
❌ Module doesn't appear in the Manage API Key list
If your S4 Solutions module isn't showing in Manage API Key:
- Confirm the module is installed and activated (Apps → search for module)
- Verify you enabled developer mode and can see the Technical menu
- Verify you're in the correct Odoo environment (development/staging/production)
- Some modules may not require API keys — check the module documentation
- Try refreshing the Manage API Key page
❌ Can't find the invoice email or text file
If you can't locate the API key email or attachment:
- Check your spam/junk folder for emails from S4 Solutions
- Search for "S4 Solutions" or "Invoice" in your email
- Verify the email address used for the purchase is correct
- Contact S4 Solutions support to request the API key be resent
Need help? Contact S4 Solutions support and provide your invoice number and module name for assistance.