Back
Building an API Integration with 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 or Account Executive.
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. This is our dedicated resource for those looking to integrate with the Yext APIs, and it contains our API documentation, guides, best practices, and other key information.
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 Generally speaking, if you are planning to build any sort of write integration where you are adding or updating entity information in Yext, you should always start by working out of a developer account so that you are not affecting production data. Once the integration is properly QA’ed you can easily switch your calls over to the production environment. To initiate integration QA with the Yext Team please reach out to your designated CSM or submit a request using this form and select Developers in the ‘What area of the platform do you need help with?’ section.
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
5. Learn more about what you can do with our APIs using the below resources
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.
Question 2 of 3
Where can I find detailed information about all the Yext APIs and proper guidelines for building an integration?
Question 3 of 3
If I am building an integration that involves writing data to the Yext platform, I should….
A Hitchhiker in the making! 🔥
