Introduction
Get up and running with the sherpa° Requirements API in just a few minutes. This guide will teach you how to add visa and COVID-19 rules to your platform with just a single API request.
1. Get API Key
If you don't have your API key yet, please contact your Partner Success Manager.
- Not sure who your Partner Success Manager is? Reach out to partners@joinsherpa.com, and they'll put you in touch with them directly!
If you are new to sherpa° and want access to the Requirements API, fill out the form here.
2. URLs
When using a sandbox API key, the URL for the below Postman collection is:
When using a production API key, please change the URL to:
3. Import Postman Collection
Postman is a tool for easy RESTful API exploration. You can use Postman to test API calls multiple times without writing code. Get started by exploring the API with sandbox credentials before moving to production.
- If you do not have Postman installed, we recommend downloading it from the Postman website.
- Click below to import the sherpa° Requirements API Collection
4. Create an Environment
Create a new Postman environment with your API Key and Affiliate ID. These values will be automatically used with all API requests done in Postman.
Don't forget to save the environment after making changes.
Make sure the correct environment is selected before making requests.
5. Make an API Request
Choose an API request from the collection. This example shows how to retrieve travel requirements for an international, one-way trip from Egypt to Canada.
The collection includes folders for each sherpa° API endpoint with preconfigured examples you can use to test each endpoint and develop an understanding of various combinations of filters.
We highly recommend visiting our official product documentation via the links below for more information about each endpoint to help you choose the correct endpoint for your business case.
