/ /

Exploring API Access for Test Environment (Sandbox) and for Live Organization

Updated 6 months ago

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.

Understanding Test vs. Live Organizations

Before accessing Kintsugi's API, it's important to understand the difference between test and live organizations:

Test Organization (Sandbox)
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 Organization
Your actual working environment where your real data and compliance processes reside.

Important Note: At this time, it isn't possible to directly convert or switch a test organization into a live organization. Test organizations are intended as sandbox environments for experimentation, training, and API testing, and they are intentionally kept separate to ensure test data does not mix with live compliance workflows.

API Access for Test Organizations

You can explore Kintsugi's API using a test organization without a paid account.

How to Get Started:

  1. Create a test organization within your Kintsugi account.

  2. Generate an API key directly from your test organization settings.

  3. Begin testing integrations and exploring API capabilities.

No premium subscription is required to create a test organization or obtain API keys for testing purposes.

API Access for Live Organizations

Both test and live organizations can be created and explored without a paid account. However, API keys for live organizations require a premium Kintsugi subscription. This ensures secure and controlled access to your production environment.

How to Get Started:

  1. Ensure you have an active premium Kintsugi subscription.

  2. Navigate to your live organization settings.

  3. Generate your API key following the steps outlined in our guide: Mastering API Keys: Creation, Management, and Security

Key Points to Remember

  • Test organizations allow you to explore Kintsugi's API and features without a paid account.

  • Live organizations can be created without a paid account, but API keys for live organizations require a premium Kintsugi subscription.

  • Test organizations provide a risk-free space for development, experimentation, and training.

  • Test organizations cannot be converted into live organizations to maintain data integrity.

By following these guidelines, you can confidently explore Kintsugi's API and integrate it into your workflows, whether you're working in a test or live organization.

Was this article helpful?