What is Kintsugi’s API?
An API (Application Programming Interface) allows different software systems to communicate with each other. Kintsugi’s API lets you programmatically interact with our platform, enabling you to automate tasks, integrate with other tools, and build custom solutions.
Test Environments vs Live Environments
Before you jump into Kintsugi’s API access, it’s essential to understand the difference between test and live environments:
Test Environment (Sandbox)
This is a safe space where you can experiment, test features, and develop integrations without affecting your real data or compliance workflows. Think of it as a practice area.
Live Environment
This is your actual working environment, where your real data and compliance processes reside.
API Access: The Key to Integration
To use Kintsugi’s API, you’ll need an API key. Here’s how to get one, depending on your preferred Kintsugi environment:
API Access in a Test Enviroment
1. Create a Test Organization
If you don’t have a paid account or want to experiment without impacting your live data, create a “Test Organization” within your Kintsugi account. This sandbox environment is perfect for exploration.
2. Obtain an API Key
Within your Test Organization, you can generate an API key without needing a premium subscription. This allows you to explore Kintsugi’s API capabilities and test your integrations freely.
API Access in a Live Enviroment
1. Premium Account Requirement
To obtain an API key for your live organization (where your real data resides), you must have a premium Kintsugi account. This ensures secure and controlled access to your production environment.
2. Creating and Deleting API Keys
Refer to this help article for complete guide: Mastering API Keys: Creation, Management, and Security
Key Takeaways
Utilize a Test Organization to explore Kintsugi’s API and features without a paid account.
API keys for live organizations require a premium Kintsugi subscription.
Test environments provide a safe and risk-free space for development and experimentation.
By following these steps, you can confidently explore Kintsugi’s API and integrate it into your workflows, whether you’re in a test or live environment. Happy integrating!