Master API Key for Partner API
Streamline your workspace management with the new master API key feature. This innovation allows partners to efficiently handle multiple workspaces using a single API key, saving time and reducing complexity. Whether you're setting up new workspaces or modifying existing ones, th
Listen to an audio overview
A short, AI-generated podcast-style summary of this article.
Streamline your workspace management with the new master API key feature. This innovation allows partners to efficiently handle multiple workspaces using a single API key, saving time and reducing complexity. Whether you're setting up new workspaces or modifying existing ones, this tool ensures seamless integration and control.
Understanding the Feature and Its Applications
Managing multiple workspaces as a partner can be time-consuming and complex. Previously, each workspace required its own API key. Now, with the introduction of this feature, you can use a single master API key. This key, combined with any workspace ID and your custom domain, allows for efficient workspace management.
Consider the process of creating a new workspace via the API. Once the workspace is created, you receive a workspace ID in the response. You can then use the master API key and this workspace ID to dynamically and automatically modify that workspace.
How to Obtain the Master API Key
To get your master API key, log into your main partner workspace. Navigate to the API keys section; any API key you find here will serve as your master API key.
Finding Your Partner API Endpoints
Switch to your workspace, go to the API keys section, and click on API documentation. Ensure you are logged in through your custom domain to access your specific API endpoints.
Including Additional Parameters
You need to include two additional parameters in the request header:
For managing team scope: only x-client-workspace-id is required.
For managing flow scope: both x-client-flow-ns and x-client-workspace-id are needed.
If your scope is "manage team," you only need to include the workspace ID parameter.
The parameters you need depend on your API endpoint's scope. For "manage flow" scope, both parameters are necessary.
Setting Up an External Request
Create an External Request and configure it as shown in the image.
In the Header, set the parameters x-client-flow-ns and x-client-workspace-id.
Enter your API Key in the Authorization section.
Navigate to all bots and copy your flow namespace.
Response: A return code of 200 signifies success.
Video Tutorials Available