Paw

Paw is a full-featured HTTP client that lets you test and describe the APIs you build or consume. It has a beautiful native macOS interface to compose requests, inspect server responses, generate client code and export API definitions. Download the Paw client from https://paw.cloud.

This article describes how to import API specification to Paw and how to use the Connect API with this client.

Prerequisites

At the moment of writing, Paw doesn’t support Open API 3.0 specification natively. Therefore, it is required to convert Connect API specification to the Open API 2.0 (Swagger) format first. Refer to the Other API Specifications article for more information.

It is also required to create a Custom token on Connect, assign required permissions and copy your API Key/Handle value.

Furthermore, make sure that the Paw client uses correct API endpoint for making calls.

API Specification Import

Once the provided API specification is converted to the Open API 2.0 (Swagger) format, import this converted file to the Paw client as described below:

1. Go to File > Import > File to open the import from file form.
2. Select your converted API specification file and click the Import button.
3. In case the specification is imported successfully, Paw displays the corresponding notification. In general, it will take few seconds to complete specification import.

Therefore, you will be able to use search functionality and quickly navigate to methods of your interest.

Make a Sample Call

Test out the functionality of the Paw client and ensure that this client works correctly by making a sample call. Follow the instructions below to configure authentication variables and successfully send a sample call:

1. Select Your Method

Access your imported API specification and select a method for sending a call.

For example, get your subscriptions on the CloudBlue Connect platform by using the Get – Assets method.

After that, switch to the URL Params tab and uncheck all provided parameters to list all your subscription objects. It is possible to use these parameters to find a specific subscription by using subscription identifiers, marketplace names, contract identifiers, and so on.

2. Specify Your Token

Once your method and URL parameters are selected, switch to the Auth tab and click Edit to specify your authorization token.

Namely, it is required to paste your API Key/Handle value as the Apikey0 variable.

3. Send a Call

Once your token configuration is finalized, perform your first call by clicking on the send icon.

The result of the query will appear at the right side of the Paw interface. Thus, you should now be ready to proceed with more advanced scenarios like adding URL parameters and working with different collections.

In case more information on the Paw client is required, please refer to Paw Documentation.