Sherpa - Visa and Travel Restrictions API

Sherpa Developer Hub

Welcome to the sherpaΒ° developer hub. We offer a suite of solutions that guides travellers from planning to a safe return home. Take a look at the integration guides, specific use cases and an interactive API Reference. Ready? Let's go.

Guides    API Reference

πŸ†• Trip Element

Personalized travel restrictions and visa requirements for your trip.

πŸ“˜

Upgrading from Requirements Widget?

Head over to the Upgrade Guide.

Don't miss our QuickStart guide.

Introduction

Embed a Trip Element on your web platform using the sherpaΒ° SDK. The Trip element provides personalized travel restrictions and visa requirements for travellers based on their itinerary.

The Element can be embedded on your web page with just a few lines of code. To see some ways you can use the Trip Element, check out our examples and the JS Fiddle.

🚧

App Id is required

You will receive a unique APP_ID during onboarding.

You need to include the sherpaΒ° SDK by adding the script tag to the head of your HTML file and include your personalized APP_ID.

<script src="https://sdk.joinsherpa.io/widget.js?appId=<<APP_ID>>"></script>

Next, create an instance of the Trip Element object and attach it to the DOM of your site by mounting it to an existing HTML element on your page.

We recommend placing an empty div element like <div id="sherpa-trip-element"></div> on your site to act as the mount point.

The element.mount accepts a valid CSS Selector.

$sherpa.V2.createElement('trip').mount('#sherpa-trip-element')

Updated about a month ago



πŸ†• Trip Element


Personalized travel restrictions and visa requirements for your trip.

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.