About API v2 and the Developer Console
This past November, Yext launched developer.yext.com, where developers can get started with our APIs and stay up to date on new features.

Some of our customers may know about our RESTful APIs that allow businesses to automate their Knowledge Management. We are very proud to announce both an update to our entire suite of APIs and a brand new interface for managing, visualizing, and debugging your integrations: API v2 and the Developer Console.

At Yext, we take pride in our integrations. We have integrated with more than 80 publisher websites to correct and maintain our customers’ business data, and we have worked with APIs of just about every shape and form along the way. With lessons learned from these integrations, our experience building APIs for our customers, and a combination of industry best practices, we set out with the goal of making the Yext Knowledge Engine a world-class developer experience.

Key Features of API v2 and the Developer Console

Here are some of the features of our new API and Developer Console that we are excited to share with the world:

Free Demo Accounts open to the public

Developers who want to test the capabilities of our Knowledge API and begin integrating with their platform can create an account, get an API key, and start developing within minutes. Go to our Get Started guide to do just that!

CreateDeveloperAccount

OpenAPI specification

We wanted better documentation for humans and computers, so we decided to implement the OpenAPI specification (OAS). Designing and maintaining our API with the OAS allows us to quickly update documentation, generate new libraries with every new feature as it is released, and let users import their code into tools like Postman to start sending requests right away.

Webhooks

Two-way communication is essential in the real-time environment of knowledge management. We decided that users of our API should never have to regularly hit our endpoints to learn about changes, so we implemented Webhooks for updates to your locations, listings, or reviews.

Logging

As every developer knows, good logging is the first step in debugging problems with an API, so we added comprehensive logging to every API call you make. We built a world-class system for logging and displaying your API requests.

Searching through logs is much more effective if you have the right tools. Here’s what we provide:
  • The ability to search by request UUID, URL, or Body
  • Filtering on:
    • Time range
    • Endpoints, granular down to HTTP Method (e.g., “Location POST”)
    • HTTP Response Code
    • Yext Error / Warning Code
  • Full HTTP Request details
DeveloperLogs2017
No matter how many API calls you send us each day, you can always pinpoint that one request that keeps failing by logging in to the Developer Console and checking the logs.

Developer Apps

Yext has a diverse set of APIs that our customers use in a wide range of applications. If you have a mobile app, a store locator on your website, and a server-side integration with our Administrative API, why use the same API key for all three?

With Apps, you can set up API keys for your different use cases. For each app, you can decide:
  • whether it has read-only or read-write access,
  • which endpoints it has access to, and
  • how much of your quota, or rate limit, to allocate to it.
AppSettings2017

Other improvements from v1

In addition to taking advantage of all forthcoming new Yext functionality, API v2 also includes:
  • Paginated responses for “List” requests, allowing for faster average response times than requests made in v1
  • Enhanced security measures, such as activity attribution and high error-rate notifications
  • Detailed error messages alerting you to immediate issues
  • A simplified implementation process, allowing you to complete your integration quickly and easily

We at Yext have seen just about every type of API in the land, so we aimed high. We’ve put together a really amazing set of features to enable our customers and developers to manage their digital knowledge. Subscribe to our blog to stay updated on the latest news about our APIs and Developer Console!