Generate OpenAPI access token

Apidog supports OpenAPI specifications from version 2.28 onward. Visit Apidog's OpenAPI documentation for more details.

This tutorial guides you through obtaining an OpenAPI access token for Apidog, which enables you to utilize Apidog's OpenAPI services efficiently.

Create a New Token

To generate a new token, follow these steps:

1. Hover over your avatar on the top right and navigate through "Account Settings" → "API Access Token".

2. Click on "Create a new personal token".

   

:::caution
This token grants the same functionality and access rights as your account across all teams and projects within Apidog.
:::

3. Enter a name for your token and choose a validity period.

4. Click "Save and generate token" to create the token. It will be displayed only once at this moment, so be sure to copy and save it immediately. Once you navigate away from this page, the token will not be visible again.

   

:::tip[]
Modifying the name or the expiration date of the token does not regenerate a new token. If you misplace it, you need to create a new token by clicking "New".
:::

Use the Token

To utilize your new token with the OpenAPI, prepare the following required request parameters:

1. The token (authorization) as generated in the "Project Settings".

2. The Project ID from the project you intend to operate on, available under "Project Settings" → "Basic Settings".

   

Next, clone the Apidog OpenAPI project and set up your environment:

1. Click on the "Environment Management" button in the top right corner.

2. Input the required parameters and save them.

   

Now, you can select the desired OpenAPI service, fill in the request parameters, and execute your API calls:

By following these steps, you'll be able to seamlessly integrate and utilize Apidog's OpenAPI functionalities.