Introduction

As a provider of SEO keyword research tools, you can integrate with Wix to enable Wix users to optimize their SEO strategy.

Using the SEO Keyword Suggestions SPI, you can design your app to:

  • Enable Wix users to check the SEO strength of a potential keyword.
  • Suggest similar keywords to compare SEO strength.
  • Provide analysis about the suggested keywords based on search volume and ranking difficulty.
  • Update Wix users about remaining credit in their plan.

How to become an SEO keyword suggestion provider

To become an SEO keyword suggestion provider, add the Seo Keywords Suggestions extension in your app's configuration in Wix Developers Center.

Provide the necessary configuration for your app:

NameTypeDescription
baseUristringRequired. Base URL of your SEO implementation. Wix sends API requests to endpoints implemented using this URL.
upgradeUrlstringURL of the page where users can purchase a paid plan. Wix offers a link to this page when you respond with a value of false in quota's paidPlan property.
supportedCountryCodesarrayRequired. List of countries you support for SEO analysis. 2-letter country code in ISO-3166 alpha-2 format.
quotaEnabledbooleanWhether there is a quota limit in the service. When set to true, include the quota object in responses.
landingPageUrlstringRequired. Your website's landing page.

Terminology

  • Suggested keywords: Keywords suggested by your app to compare SEO strength of potential keywords and enable optimization of SEO strategy.

  • Quota: Details of the plan such as credit remaining in terms of number of searches left, total available searches, and start and end dates of the quota cycle.

Was this helpful?
Yes
No

Sample Flows

This article shares some use cases your app could support, as well as a sample flow that could support each use case. You're certainly not limited to these use cases, but they can be a helpful jumping off point as you plan your app's implementation.

SEO List Suggested Keywords Flow

A Wix user wishes to determine the strongest SEO keywords for their site. When the quotaEnabled parameter is set to true in the configuration, you return a quota object in addition to the data object.

  1. The Wix user provides a keyword to Wix to check its SEO strength.

  2. Wix sends a List Suggested Keywords request to your app using the configured baseUri.

    Copy
    1
    {
    2
    "keyword": "pizza",
    3
    "countryCode": "US"
    4
    }
  3. Your app sends a response.

    Wix expects an object containing either a 4xx HTTP status code (and some errors) or a 200 HTTP status code and the List Suggested Keywords response.

You can see an example of the response in the List Suggested Keywords code example.

Get Quota Flow

When a Wix user initially opens the SEO page in the Dashboard, Wix requests information about the current quota plan.

  1. The Wix user opens the SEO page in the Dashboard.

  2. Wix sends a Get Quota request to your app using the configured baseUri. No parameters are sent.

  3. Your app sends a response.

    Wix expects an object containing either a 4xx HTTP status code (and some errors) or a 200 HTTP status code and the Get Quota response.

You can see an example of the response in the Get Quota code example.

Was this helpful?
Yes
No

PostList Suggested Keywords

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

This endpoint requests keyword suggestions for a specified phrase. You provide statistical data about the requested keyword and a list of similar keywords so the user can compare the SEO strength of the suggested keywords.

Wix calls this endpoint when a Wix user requests data about a keyword via the SEO page of the Dashboard.

You cannot try out this endpoint because it has to be implemented by an app and can have an arbitrary URL. So please ignore the Authorization and POST sections below as well as the Try It Out button.

Was this helpful?
Yes
No

PostGet Quota

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

This endpoint requests information about remaining quota in the plan. A Wix user can purchase a paid plan from your site or utilize a free plan if you offer one. You provide information about the current plan including how many searches remain out of the total in the plan, the dates of the plan, and whether the user currently has a paid plan.

Wix calls this endpoint when a Wix user opens the SEO page of the Dashboard.

You cannot try out this endpoint because it has to be implemented by an app and can have an arbitrary URL. So please ignore the Authorization and POST sections below as well as the Try It Out button.

Was this helpful?
Yes
No