Master API Key for Partner API

Master API Key for Partner API

What is it? What's the user case?

As a partner, managing multiple workspaces can take time and effort. Previously, you needed separate API keys for each workspace. However, with this new feature, you'll have a single master API key. You can use this key, any workspace ID, and your custom domain to manage that workspace efficiently.

Imagine creating a new workspace through the API. Upon creation, you receive a workspace ID in the response. Subsequently, using the master API key along with the workspace ID, you can dynamically and automatically make changes to that workspace.

Obtaining the Master API Key: 

First, acquire the master API key from your main partner workspace. Ensure you're logged into your main partner workspace, navigate to API keys, and any API key within this workspace serves as your master API key.

Locating Your Partner API Endpoints: 

Switch to your workspace, access API keys, and click on API documentation. Make sure you're logged in from your custom domain to view your specific API endpoints.


Adding extra parameters: 

Two additional parameters need inclusion in the request header: 

  • Manage team scope: you will only need x-client-workspace-id

  • Manage flow scope: you will need x-client-flow-ns & x-client-workspace-id

If the scope is “manage team,' only the workspace ID parameter is necessary. 



These parameters depend on the scope of your API endpoints. If the scope is 'manage flow,' both parameters are required. 

Setup External Request: 

Create External Request and set it up like follow in the image

  1. In Header set parameter x-client-flow-ns & x-client-workspace-id

2. Enter your API Key in the Authorization

  1. Go to all bots and copy your flow ns.

​
Response: If the return code is 200, it indicates success.

​

    • Related Articles

    • Test OCP partner API (Thrivecart)

      In this section, we will start testing the OCP partner API, you will first need to generate an API key from your main workspace (the workspace has the white label settings), please note this is only for our partner plan. If you want to join our ...

    • Authorize with your partner API

      Authorize with your partner API After you get your API keys, you can test with our partner APIs. And click the authorization button, and paste your API keys: Now you have authorized successfully, you can test the endpoints we have for our partners ...

    • Partner Settings

      Billing type We offer two different billing type. it’s billing URL and Internal Billing. Internal Billing If you have Stripe account, we suggest you select “Internal Billing” option, and then go to your main partner workspace integration tab and ...

    • API

      Intro to APIs OCP API is used to retrieve data from the flow you build. Here are some examples that you could do with OCP API. Pull the flow you have built from OCP. Create, delete or obtain data including flow tag, flow field. Dealing with the data ...

    • Get your API keys

      In order to use our partner APIs, you will need first to get your API keys. In your main workspace (the workspace has the white-label settings), you can go to the top right corner of your dashboard, and then click the API keys. And then you can give ...