Testing the APIs

Test an API in Swagger

1. Go to the Swagger page for the API that you need.

   For example, you can find the Data Preparation API at https://localhost/dp/swagger-ui/index.html, where “localhost” is the name or IP address that was configured for the Platform.

2. Select the following server variables:

   • protocol – Select “https” if you use SSL.

   • serverPath – The entry point configured for the Platform (such as 10.15.16.888 or company.com).

   

3. Click Authorize and paste your Bearer token (without “Bearer” prefix).

   Note: To get the Bearer token, see API authentication.

   

   Click Authorize, and then click Close.

4. Go to the API endpoint that you want to test and click Try it out.

   

5. Specify the data for the request and click Execute.

   The examples in the specification use sample data and fake credentials, make sure you use your data for testing.

   Review the response.

Download an OpenAPI specification

You can download the OpenAPI specification file, view it in a text editor, or even import it into Postman for further testing.

1. Go to the Swagger page for the API that you need.

   For example, you can find the Data Preparation API at https://localhost/dp/swagger-ui/index.html, where “localhost” is the name or IP address that was configured for the Platform.

2. Click the first link that ends in “.yaml” and download the file.

   

3. View the specification file.