DEVELOPER HUB
Embeddable Tools
Missing documents? 
Make sure you sign in to your account.

Postman Setup Guide

By simply importing one of our API Spec document into Postman you can start using the Perch API nearinstantly. Follow the guide below to download and import an Open API Spec into Postman.

Requirements

Download API Specs

Please contact us at partnersupport@myperch.io should you have any challenges or questions attaining any of the above.

Setup Instructions

A. Click Import in Postman.

B. Find the OpenAPI spec file to import.

  1. Select OpenAPI 3.1 with a Postman Collection
  2. Click into View Import Settings before doing the import

C. Set the import settings as follows:

  1. Set Parameter generation to Example
  2. Set Folder organization to Tags
  3. Click the back arrow to return to the previous screen and click Import

D. Once imported, you will be able to see the imported Definition and Collection

  1. Open the APIs section
  2. Expand the sections to view the Definition and the Perch Partner API Collection.

E. Set the API key using the provided API key

  1. Open the Perch Partner API Collection
  2. Open the Variables section and add the apiKey variable. This will apply the API key to all the requests in the collection.

F. To view the data schema for a Lead, you can view the schema in the Definition section

  1. View index.json under the Definition
  2. In the Components > schemas section, you will find the Lead schema definition. This outlines all the data fields and their acceptable values.

G. To view a sample HTTP request for Leads, open up the Perch Partner API > Lead section.

  1. Choose a request in the collection
  2. View the Body of the request if applicable (e.g. POST/PATCH requests). To set the :id in the URL path, open the Params section
  3. Clicking Send will make a request to the API based on the baseUrl in the Variables section from Step E. This is the test environment by default.