Only subscribers on any paid Plus plan can access oboloo's API

API keys allow organisations to securely integrate the platform with other systems, enabling automated data exchange and real-time updates between different platforms.

An API key acts as a secure authentication token, ensuring that only authorised users can access or manipulate data via API requests.

This guide will walk you through creating an API key, refreshing it when necessary, and testing it within the API documentation to confirm successful authentication.

Only users with the appropriate access can access the API within oboloo. To find out more about user access rights, please check out this user guide here.

When to Use This Feature

✅ When integrating the platform with third-party applications or internal systems.
✅ When automating data exchange between the platform and other software.
✅ When testing API requests using the platform’s API documentation.
✅ When refreshing an existing API key for security purposes.

Step-by-Step Guide: Creating an API Key

Step 1: Navigate to API Authentication

  • Click on Settings from the main menu.

  • Click on API Authentication.

Step 2: Generate a New API Key

  • Enter a name for your API key in the API Key Name field.

  • Click on the Generate API Key button.

  • Your new API key will now appear in the table below, along with any existing keys.

Step 3: Copy the Secret Key

  • Locate your newly generated API key in the table.

  • Copy the secret key, as you will need this to authenticate your API requests.
    📌 Note: API keys are refreshed automatically every 24 hours for enhanced security. You can also manually refresh an API key if needed.

Refreshing an API Key

If you need to update an existing API key for security purposes:

  • Navigate to Settings > API Authentication.

  • Find the existing API key in the table.

  • Click on Refresh next to the key to generate a new secret key.
    📌 Important: If you refresh an API key, you will need to update any integrations using the old key with the new one.

Using the API Key for Authentication

Now that you have generated your API key, you can use it to authenticate and integrate the platform with other systems. If you are unsure how to use APIs for integrations, contact your IT team for assistance.

To verify that your API key is working correctly, you can test it using the API documentation page.

Step-by-Step Guide: Testing an API Key in API Documentation

Step 1: Access the API Documentation

  • Click on API Documentation from the API Authentication page.

Step 2: Authenticate Yourself

  • In the API documentation, enter the start of your platform domain in the Domain field.
    📌 Example: If your platform URL is companyname.platform.com, enter companyname.

  • Click Authenticate.

Step 3: Authorize API Access

  • Click the Authorize button.

  • Enter the secret key from the API key you just created.

  • Click Authorize to confirm authentication.

Step 4: Test API Requests

  • Scroll down and expand any API endpoint you want to test.

  • Click Try it out to enter test parameters.
    📌 Example: To retrieve a list of suppliers, go to the Suppliers section and expand Get List of Suppliers.

  • Apply any filters if needed (e.g., filter by status or location).

  • Click Execute to run the request.

  • If successful, supplier data will be returned in JSON format.

Step 5: Troubleshooting Authentication Issues

If an unauthenticated message appears instead of the expected data:

  • Ensure you have copied and entered the correct secret key.

  • Try creating a new API key and re-authenticating.

  • Verify that the API key has not expired or been refreshed.

Key Considerations & Best Practices

✅ Keep API Keys Secure – Never share your API key publicly or store it in unsecured locations.


✅ Refresh API Keys Regularly – API keys are refreshed automatically every 24 hours but can be manually refreshed if needed.


✅ Use API Documentation for Testing – Before integrating with other platforms, always test API calls to verify authentication and functionality.


✅ Contact IT for Integration Support – If you are unsure how to integrate API requests, reach out to your IT team for assistance.

Additional Resources

📌 Related User Guides:

📌 Need Further Help?
If you need further assistance, please contact your internal platform administrator for support. Otherwise please reach out to oboloo's support team. If you are unable to view the above area in the oboloo platform, please check your user permissions and access rights.