This guide explains how to connect to Pattern’s API and configure a test collection in Postman. For complete endpoint documentation—schemas, parameters, and sample responses—see Pattern’s API reference. You can find more implementation details in the other articles in this section.
Requesting API Credentials
If your organization's Pattern account as API access enabled, request API credentials by submitting a support request. In the support request, please be sure to include the email address for your Pattern account.
You will receive a temporary secure link with a client ID and secret to use to authenticate to the Pattern API at the email you use for your Pattern account.
Postman Connection and Testing
After receiving your credentials, use Postman to connect and test your credentials.
1. Import the API Collection
Select "Import" from Postman's left side menu bar.
In the resulting window, paste the link to Pattern's OpenAPI documentation, found here https://service.patterndata.io/pattern/documentation/openapi.yaml:
Select the "OpenAPI 3.0 with a Postman Collection Option and click "Import". This selection will include API definition files:
2. Set Up Authentication
The easiest way to set up Pattern authentication in Postman is using the "OAUTH2" parent authentication. To do this, navigate to the second level "Pattern" folder here, then select "Authentication":
Next, select "OAuth2.0" on the "Type" drop down. After selecting "OAuth 2.0", scroll down to "Configure New Token" and fill out the following form:
Within this form, use the client ID and client secret provided by Pattern. Use "https://service.patterndata.io/pattern/auth/token" as the "Access Token URL". Once filled out, click "Get New Access Token" at the bottom of the page. After this completes, you will see the new token in the following drop down:
Selecting "Auto-refresh" is recommended, it will allow you to re-use this same token and not need to manually re-authenticate.
At this point, you are ready to start exploring the API.
3. Validate Access
To validate the authentication credentials, navigate to the lens/list endpoint:
The resulting call of that API should list the lenses available over API within your account. You may need to set the authentication on a call to "Inherit Auth from Parent" if Postman does not automatically set the authentication on the call: