Trying out the Web SDK in an OpenAPI viewer

You can use an OpenAPI viewer to confirm your own application integration to Trust Protection Platform. You can also try the code samples from this guide. Trust Protection Platform supports the following viewers:

  • OpenAPI Explorer

  • Swagger

  • Redoc

Your system administrator selects whether this feature is enabled and which viewer is set by default in the Venafi Configuration Console. See Access Management for details.

IMPORTANT   By design, the OpenAPI viewer operates only from an installed instance of Trust Protection Platform. The framework does not run on the documentation portal (docs.venafi.com). Because REST API calls can change data, be sure to run OpenAPI viewer calls only from your test Trust Protection Platform instance.

You do not have to use the default viewer set by your administrator. For information on using the viewer of your choice, see Trying out the Web SDK in an OpenAPI viewer.

Prerequisites

Applications that use Venafi REST APIs require an extra configuration. You can get the existing configuration from the API Integrations page. You need a valid Client ID as the client_id, and the corresponding scopes and restrictions. For more information, see Setting up token authentication.

Client ID is the Application ID

OpenAPI Viewer not available for this site

You are on docs.venafi.com, so the OpenAPI viewer is not available from this page. If you were viewing this page on a correctly-configured Venafi server you would see the OpenAPI viewer below.

Follow these steps to see the OpenAPI viewer on your Venafi server.

To try out the Web SDK in the Default OpenAPI viewer

  1. To open the OpenAPI viewer, use a fully qualified domain name. Do one of the following:

    • Access the OpenAPI viewer from the same URL that manages Trust Protection Platform from a web browser. For example, https://TestTPP.example.com/vedsdk. If the computer lacks a domain name or there is a problem in IIS, the site will be unreachable.

      TIP  The /vedsdk url will display the default viewer. To use another viewer, see Testing the Web SDK from the browser

    • Run the OpenAPI viewer from this help page. If you navigated via the UI Help link, the API documentation appears near the end of this page. Otherwise, if your browser ignores X-frame headers, the service is not running, or if you navigated to this page in any other way than your Trust Protection Platform instance of help, the OpenAPI viewer will be missing from this page.
  2. Expand authorize.
  3. Expand POST /vedauth/authorize/oauth, and then click Try it out.

  4. In the request, add the values to an Authorize call, and then click Execute button.
  5. From the Response body box, copy the token value.
  6. Click Authorize button.
  7. To add the bearer token to the request header for other API calls, paste the token in the Value field and click Authorize.
  8. Begin making other API calls.