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.

Want to learn more?

Learn more about what you can do with our APIs:

unit Quiz

+20 points

Daily Quiz Streak: 0

Quiz Accuracy Streak: 0

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.

True

False

Question 2 of 3

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

My Client Success Manager

The Yext API support team

This unit in the Hitchhiker training

hitchhikers.yext.com/docs

Question 3 of 3

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

Start by working out of a developer account so that I am not affecting production data

Start by playing around in the production account and cross my fingers nothing goes wrong

Start by creating dummy information in the production account, and only sending calls that affect that data

Way to go, you passed! 🏁

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.

1^st attempt

0 incorrect

<% elem.innerText %>