How to Create and Manage API Keys for Secure Integrations

This tutorial will guide you through creating and managing API v3 keys in Document360. You will learn how to configure scoped API keys, apply granular access controls, manage key security, and explore the expanded API capabilities available with API v3.

Accessing API Keys

To get started with API keys:

• Navigate to Settings in Document360.
• Under Knowledge base portal settings, select API Keys.

Choosing an API Specification

The API Keys page provides two options for creating API keys:

• V2 – Uses the legacy API specification.
• V3 – Uses the new specification with an expanded API surface and enhanced security controls.

To create a new key, select the V3 specification.

API v3 introduces a stronger OAuth 2.0 authentication model, more granular access controls, and expanded endpoint coverage.

Creating an API v3 Key

To create a new API v3 key:

• Enter a name for the API key.
• Configure the required access settings.
• Select a portal role.
• Select a content role.
• Define the content access scope.

You can further restrict the key’s access based on:

• Workspace
• Language
• Category
• Specific articles

You can also configure an expiry date and set the visibility duration for drive assets.

This allows you to provide integrations with only the permissions they need.

Securing Your API Key

Once the API key is generated, copy the key and store it securely.

For security reasons, the secret key is displayed only once and cannot be viewed again later. Make sure you save it in a secure location immediately after creation.

Managing API Keys

After creating a key, you can view important information such as:

• Key status
• Usage details
• Access summary

If a key is no longer required, you can revoke or delete it at any time.

You can create up to eight active API keys per project.

Managing Existing V2 Keys

If you have previously created API keys using the V2 specification, you can continue to access them from the dedicated V2 tab.

However, we recommend moving to API v3 to take advantage of its enhanced security, granular access controls, and expanded API coverage.

Exploring API v3 Capabilities

API v3 provides a significantly expanded API surface, with more than 75 new endpoints in addition to the existing 130+ endpoints.

Scoped API keys provide controlled access across resource groups covering areas such as:

• Analytics
• Security
• Content reuse
• AI capabilities
• And more

Together, these capabilities make it easier to build secure and scalable integrations with Document360.

Conclusion

API v3 in Document360 gives you greater control over authentication, permissions, and access to your documentation resources. By configuring scoped API keys and granular access controls, you can build secure integrations while ensuring that each integration has access only to the resources it needs.

Create your API v3 key, configure the appropriate permissions, and start exploring the expanded API capabilities in Document360.

View all