<% user.full_name %>
<% util.level ? util.level.title : '' %>
Explorer Pioneer Apollo Viking Voyager Pathfinder Orion
Points
<% user.points ? user.points.toLocaleString() : 0 %>
Badges
<% util.badgeCount %>
Streaks
Congratulations You've <% util.newestBadge.isCurriculum ? 'completed' : 'earned' %> the
<% util.newestBadge.title %> <% util.newestBadge.isCurriculum ? 'curriculum' : 'badge' %>!
previous
next
Share to Social Media
Linked In Facebook
Status
<% util.level ? util.level.title : '' %>
<% util.level ? util.level.points : '' %>
<% util.nextLevel ? util.nextLevel.title : '' %>
<% util.nextLevel ? util.nextLevel.points : '' %>
Level up! <% util.levelPointsRemaining %> points to go
Level up! <% util.levelPointsRemaining %> points to go
Badges
Completed Hitchhikers Track Completed Content Track Completed Pages Track Completed Page Builder Track Completed Search Backend Track Completed Search Frontend Theme Track Completed Search UI React Track Completed Solution Templates and the Admin Console Track Completed Technical Skills Track Completed Platform Basics Track Completed Listings Track Completed Reviews Track Completed Industry Overview Track Completed Analytics Track Completed Industry Overview & Product Basics Track Completed Multi-Language Experiences Track Completed Chat Track
<% util.expandBadges ? 'Less' : 'More' %>
Playground Accounts
New +
No Playground Accounts
Create Playground +
View Profile
Log Out loading
Mission Complete! 🚀
Congratulations, you’ve completed your first module!

We hope you enjoy exploring the rest of the site. Please don’t forget to leave us feedback - we are constantly looking to improve. Happy Hitchhiking!
Home
Welcome to Hitchhikers! 👋
To learn more about the platform we encourage you to get started by completing the Hitchhikers Program Track and earning your first badge!
Start Here
Close notification
Guide
Using JWT with Search
Arrow Back
Completed
Introduction
Introduction
completed
Completed 1
Step 1
Request the JWT
completed
Completed 2
Step 2
Pass the JWT to Search
completed
Completed 3
Step 3
Refresh the JWT
completed
Next Steps
Appendix
completed
home

Introduction | Yext Hitchhikers Platform

Overview

Search API calls can be made using JWT (JSON Web Tokens) in place of an API key. JWTs are used to authenticate users and can be seen as short-term, personal API tokens that carry user information. There are lots of good materials on JWT , and it has some significant advantages over using a plain API key; specifically, you can use fixed_query_params in a JWT to pass context for query rules, making it so users can only view a specific set of entities (or other query rule applications). Even if the JWT is shared, it will always keep those fixed_query_params. Here’s an outline of how it works with our APIs and SDKs:

  1. The implementer will make a server side request for a JWT using our secure token API .
  2. They pass that token to the Search API (or Content Delivery API) in place of the API key to get a response.
  3. The token eventually expires and the implementer requests a new one.

Preparation

To use JWT with your Search experience, there are a few things you’ll need to do in advance:

  1. Confirm you are on theme version 1.22 or later. This theme has support for a Runtime Configuration, which is used to use JWT in place of your API key. For more information on Theme 1.22, visit the Theme Changelog .
  2. Set useJWT and initializeManually to true in the Theme’s global_config.json. For more information on the global_config.json, visit the Global Settings and Local Configuration reference doc. You also want to be sure that you do not set the usual apiKey as you are using the JWT in place of your API key.

  3. Create a new developer app with the following permissions:

    • Secure Token Content Delivery API - Read / Write
    • Q&A Submission - Read / Write
    • Locations (Content Delivery API) - Read-Only
    • Entities (Content Delivery API) - Read-Only

    For more information on setting up an App, visit our Get Started guide .

  4. If you’re using the JS Snippet integration option, follow the normal steps to add the Search results page .

Feedback
<% elem.innerText %>