<% 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
Introduction to APIs
Arrow Back
Unit 1
What is an API?
completed
Unit 2
Read vs Write APIs
completed
Unit 3
API Use Cases & Yext
completed
Unit 4
Yext APIs Overview
completed
Unit 5
Building an API Integration with Yext
completed
assessment assessment
Module Assessment
completed completed
home

Building an API Integration with Yext | Yext Hitchhikers Platform

What You’ll Learn

In this section, you will learn:

  • Build options (Yext built or Client built)
  • How to get started

Build Options

The first thing you should know about building an API Integration with Yext is that you can either build it yourself with your own development resources (and support from our team), or you can pay Yext to build it for you.

If you are interested in paying for a Yext-built API Integration, please consult your Client Success Manager.

Getting Started

For all of the information that you need to get started building your own API, please visit our Documentation Hub at hitchhikers.yext.com/docs .

You should always start by scoping out the type of integration you want to build (read vs write, analytics related vs entity data), determining which of our APIs is relevant, and then following the proper guides in our developer documentation (listed below)

Once you have determined the scope of your integration and which API you want to leverage, you can get started by following the instructions here in our Get Started guide . These instructions are also briefly summarized below (please refer directly to the developer documentation for the full instructions):

1. Create a developer account. It’s best practice to build and test integrations in a sandbox environment. Once your integration is properly QA’ed you can easily switch your calls over to the production environment.

2. Create an App in the Developer Console. Learn more about Apps and the Developer Console here !

3. Get your API key from your newly created app.

4. Send your first API Get request.

light bulb
Want to learn more?
unit Quiz
+20 points
Daily Quiz Streak Daily Quiz Streak: 0
Quiz Accuracy Streak Quiz Accuracy Streak: 0
    Error Success Question 1 of 3

    True or False: I can build my own integration, or scope out the possibility of paying Yext to build the integration on my behalf.

    Error Success Question 2 of 3

    Where can I find detailed information about all the Yext APIs and proper guidelines for building an integration?

    Error Success Question 3 of 3

    If I am building an integration that involves writing data to the Yext platform, I should….

    Wahoo - you did it! 🙌

    You've already completed this quiz, so you can't earn more points.You completed this quiz in 1 attempt and earned 0 points! Feel free to review your answers and move on when you're ready.
1st attempt
0 incorrect
Feedback
<% elem.innerText %>